Update README.md

2023-09-19 22:56:18 +02:00 · 2023-09-19 22:56:18 +02:00 · 8b6abb2b8a
parent 3dcd95d0b6
commit 8b6abb2b8a
1 changed files with 86 additions and 53 deletions
--- a/README.md
+++ b/README.md
@ -1,64 +1,97 @@
-PlantUML
-========
+# PlantUML

-[![Discord server](https://img.shields.io/discord/1083727021328306236?color=5865F2&logo=discord&logoColor=white)](https://discord.gg/sXhzexAQGh)
-[![GitHub Sponsors](https://img.shields.io/github/sponsors/plantuml?logo=github)](https://github.com/sponsors/plantuml/)
-[![GitHub Org's stars](https://img.shields.io/github/stars/plantuml)](https://github.com/plantuml/plantuml/stargazers/)
-[![GitHub watchers](https://img.shields.io/github/watchers/plantuml/plantuml)](https://github.com/plantuml/plantuml/watchers/)
-[![GitHub contributors](https://img.shields.io/github/contributors-anon/plantuml/plantuml?color=blue)](https://github.com/plantuml/plantuml/graphs/contributors)
-[![GitHub forks](https://img.shields.io/github/forks/plantuml/plantuml)](https://github.com/plantuml/plantuml/network/)
-[![GitHub all releases](https://img.shields.io/sourceforge/dt/plantuml?color=blue)](https://github.com/plantuml/plantuml/releases)
+Generate UML diagrams from textual descriptions.

-[![online](https://img.shields.io/endpoint?url=https://www.plantuml.com/plantuml/badge)](https://www.plantuml.com/plantuml)
-[![rate](https://img.shields.io/endpoint?url=https://www.plantuml.com/plantuml/rate)](https://www.plantuml.com/plantuml)
-[![peak](https://img.shields.io/endpoint?url=https://www.plantuml.com/plantuml/rate?peak)](https://www.plantuml.com/plantuml)
+![Discord server](https://img.shields.io/discord/1083727021328306236?color=5865F2&logo=discord&logoColor=white)
+![GitHub Sponsors](https://img.shields.io/github/sponsors/plantuml?logo=github)
+![GitHub Org's stars](https://img.shields.io/github/stars/plantuml)
+![GitHub watchers](https://img.shields.io/github/watchers/plantuml/plantuml)
+![GitHub contributors](https://img.shields.io/github/contributors-anon/plantuml/plantuml?color=blue)
+![GitHub forks](https://img.shields.io/github/forks/plantuml/plantuml)
+![GitHub all releases](https://img.shields.io/sourceforge/dt/plantuml?color=blue)

-[![Release (latest by date)](https://img.shields.io/github/v/release/plantuml/plantuml)](https://github.com/plantuml/plantuml/releases/latest)
-[![Release Date](https://img.shields.io/github/release-date/plantuml/plantuml?color=blue)](https://github.com/plantuml/plantuml/releases/latest)
-[![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/plantuml/plantuml/latest)](https://github.com/plantuml/plantuml/commits/)
+![online](https://img.shields.io/endpoint?url=https://www.plantuml.com/plantuml/badge)
+![rate](https://img.shields.io/endpoint?url=https://www.plantuml.com/plantuml/rate)
+![peak](https://img.shields.io/endpoint?url=https://www.plantuml.com/plantuml/rate?peak)

-[![Pre-release (latest by date)](https://img.shields.io/github/v/release/plantuml/plantuml?color=chocolate&include_prereleases)](https://github.com/plantuml/plantuml/releases/tag/snapshot)
-[![Pre-release Date](https://img.shields.io/github/release-date-pre/plantuml/plantuml?color=chocolate)](https://github.com/plantuml/plantuml/releases/tag/snapshot)
-[![GitHub last commit](https://img.shields.io/github/last-commit/plantuml/plantuml?color=chocolate)](https://github.com/plantuml/plantuml/commits/)
-[![CI](https://github.com/plantuml/plantuml/actions/workflows/ci.yml/badge.svg?color=chocolate)](https://github.com/plantuml/plantuml/actions/workflows/ci.yml)
+![Release (latest by date)](https://img.shields.io/github/v/release/plantuml/plantuml)
+![Release Date](https://img.shields.io/github/release-date/plantuml/plantuml?color=blue)
+![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/plantuml/plantuml/latest)

-Generate UML diagram from textual description
+![Pre-release (latest by date)](https://img.shields.io/github/v/release/plantuml/plantuml?color=chocolate&include_prereleases)
+![Pre-release Date](https://img.shields.io/github/release-date-pre/plantuml/plantuml?color=chocolate)
+![GitHub last commit](https://img.shields.io/github/last-commit/plantuml/plantuml?color=chocolate)
+![CI](https://github.com/plantuml/plantuml/actions/workflows/ci.yml/badge.svg?color=chocolate)

 [PlantUML is **not** affected by the log4j vulnerability.](https://github.com/plantuml/plantuml/issues/826)

-PlantUML is a component that allows to quickly write:
+## About

- * [Sequence diagram](http://plantuml.com/sequence-diagram),
- * [Use case diagram](http://plantuml.com/use-case-diagram),
- * [Class diagram](http://plantuml.com/class-diagram),
- * [Object diagram](http://plantuml.com/object-diagram),
- * [Activity diagram](http://plantuml.com/activity-diagram-beta) (here is [the legacy syntax](http://plantuml.com/activity-diagram-legacy)),
- * [Component diagram](http://plantuml.com/component-diagram),
- * [Deployment diagram](http://plantuml.com/deployment-diagram),
- * [State diagram](http://plantuml.com/state-diagram),
- * [Timing diagram](http://plantuml.com/timing-diagram).
- 
-The following non-UML diagrams are also supported:
- * [JSON data](http://plantuml.com/json)
- * [YAML data](http://plantuml.com/yaml)
- * [Extended Backus-Naur Form (EBNF) diagram](http://plantuml.com/ebnf)
- * [Regular Expression (regex) diagram](http://plantuml.com/regex)
- * [Network diagram (nwdiag)](http://plantuml.com/nwdiag)
- * [Wireframe graphical interface or UI mockups (salt)](http://plantuml.com/salt)
- * [Archimate diagram](http://plantuml.com/archimate-diagram)
- * [Specification and Description Language (SDL)](http://plantuml.com/activity-diagram-beta#sdl)
- * [Ditaa diagram](http://plantuml.com/ditaa)
- * [Gantt diagram](http://plantuml.com/gantt-diagram)
- * [MindMap diagram](http://plantuml.com/mindmap-diagram)
- * [Work Breakdown Structure diagram (WBS)](http://plantuml.com/wbs-diagram)
- * [Mathematic with AsciiMath or JLaTeXMath notation](http://plantuml.com/ascii-math)
- * [Entity Relationship diagram (IE/ER)](http://plantuml.com/ie-diagram)
+PlantUML is a component that allows you to create various UML diagrams through simple textual descriptions. From sequence diagrams to deployment diagrams and beyond, PlantUML provides an easy way to create visual representations of complex systems.

-Furthermore:
- * [Hyperlinks and tooltips](http://plantuml.com/link)
- * [Creole](http://plantuml.com/creole): rich text, emoticons, unicode, icons
- * [OpenIconic icons](http://plantuml.com/openiconic)
- * [Sprite icons](http://plantuml.com/sprite)
- * [AsciiMath mathematical expressions](http://plantuml.com/ascii-math)
+### Supported Diagram Types
+
+- UML Diagrams
+  - [Sequence](http://plantuml.com/sequence-diagram)
+  - [Use case](http://plantuml.com/use-case-diagram)
+  - [Class](http://plantuml.com/class-diagram)
+  - [Object](http://plantuml.com/object-diagram)
+  - [Activity (beta)](http://plantuml.com/activity-diagram-beta)
+    - [Legacy syntax](http://plantuml.com/activity-diagram-legacy)
+  - [Component](http://plantuml.com/component-diagram)
+  - [Deployment](http://plantuml.com/deployment-diagram)
+  - [State](http://plantuml.com/state-diagram)
+  - [Timing](http://plantuml.com/timing-diagram)
+- Non-UML Diagrams
+  - [JSON data](http://plantuml.com/json)
+  - [YAML data](http://plantuml.com/yaml)
+  - [EBNF](http://plantuml.com/ebnf)
+  - [Regex](http://plantuml.com/regex)
+  - [Network (nwdiag)](http://plantuml.com/nwdiag)
+  - [UI Mockups (salt)](http://plantuml.com/salt)
+  - [Archimate](http://plantuml.com/archimate-diagram)
+  - [SDL](http://plantuml.com/activity-diagram-beta#sdl)
+  - [Ditaa](http://plantuml.com/ditaa)
+  - [Gantt](http://plantuml.com/gantt-diagram)
+  - [MindMap](http://plantuml.com/mindmap-diagram)
+  - [WBS](http://plantuml.com/wbs-diagram)
+  - [Mathematical Notations (AsciiMath, JLaTeXMath)](http://plantuml.com/ascii-math)
+  - [IE/ER](http://plantuml.com/ie-diagram)
+
+### Additional Features
+
+- [Hyperlinks and tooltips](http://plantuml.com/link)
+- [Rich text (Creole) with emoticons, unicode, and icons](http://plantuml.com/creole)
+- [OpenIconic icons](http://plantuml.com/openiconic)
+- [Sprite icons](http://plantuml.com/sprite)
+- [AsciiMath mathematical expressions](http://plantuml.com/ascii-math)
+
+### Learn More
+
+For a more detailed overview, visit [PlantUML Official Website](https://plantuml.com/).
+
+## Getting Started
+
+Whether you're looking to use PlantUML as a standalone application or as a component in your own project, getting started is simple. Check out the official [PlantUML setup guide](https://plantuml.com/starting) for instructions on how to set up PlantUML on your system.
+
+## Contributing
+
+PlantUML is an open-source project, and we welcome contributions of all kinds. Whether you're helping us fix bugs, improve the docs, or spread the word, we appreciate your support. See our [contributing guide](CONTRIBUTING.md) for more information on how to get started.
+
+## Support and Community
+
+- [GitHub issues](https://github.com/plantuml/plantuml/issues/)
+- [Community Forum](https://forum.plantuml.net/)
+
+## License
+
+PlantUML is licensed under several licenses; you can choose the one that suits you best:
+
+- [GPL license](https://www.gnu.org/licenses/gpl-3.0.html)
+- [LGPL license](https://www.gnu.org/licenses/lgpl-3.0.html)
+- [Apache license](https://www.apache.org/licenses/LICENSE-2.0)
+- [Eclipse Public license](https://www.eclipse.org/legal/epl-2.0/)
+- [MIT license](https://opensource.org/licenses/MIT)
+
+For more information, please refer to the [PlantUML license FAQ](https://plantuml.com/en/faq#ddbc9d04378ee462) to help determine which license is appropriate for your use case.

-To know more about PlantUML, please visit https://plantuml.com/