diff --git a/README.md b/README.md index 7931c23..da67191 100644 --- a/README.md +++ b/README.md @@ -1 +1,77 @@ -# icely-activitystorming \ No newline at end of file +

+
+ Icely Activity Storming +
+ Icely Activity Storming +
+

+ +

A Modeling Tool and metamodel for explore, visualize, design, formalize business domain.

+ +

+ GitHub release (latest by date) + GitHub last commit + GitHub + GitHub Repo stars +

+ +

+ About • + Key Features • + How To Use • + Roadmap • + Contributing • + License +

+ +![screenshot](docs/screenshot.png) + +## About +Activity Diagram + Event Storming = **Icely Activity Storming** !! + +Icely Activity Storming is a modeling tool for and metamodel for explore, visualize, design, formalize business domain and behavioural view. + +## ✨ Key Features +* Design clean and maintainable Event-Driven software and CQRS Architecture +* Dig into the business flow +* Explore and Visualize Domain Model +* Generate EMF-Based and GMF-Based Model +* Usable as Standalone Package + +## 🚀 How To Use + +### Using Update Site +You can use the update site through the `Help->Install new software` menu in Eclipse to install Icely Activity Storming from: +[https://icelyframework.github.io/icely-activity-storming/updates/](https://icelyframework.github.io/icely-activity-storming/updates/) + +### Using Standalone as Package +To use Icely Activity Storming as standlone package, JARs are available from Maven Central. to use Icely Activity Storming JAR from your `pom.xml`: +(In Progress) + +## Development (In Progress) + +## ☑ Roadmap +If you want to see a new feature feel free to create a new Issue. Here are some features which are either underway or planned: + +- [ ] Deploy To Maven Central + +If you'd like to give any of these a shot feel free to contribute. + +## Support + +Buy Me A Coffee + +## License + +Copyright © 2021 [Amir Deljouyi](https://github.com/amirdeljouyi). +Icely Annotator is made available under the [MIT](https://github.com/IcelyFramework/icely-annotator/blob/main/LICENSE) licensed. + +## 🤝 Contributing +Contributions, issues and feature requests are welcome. +Feel free to check [issues page](https://github.com/IcelyFramework/icely-annotator/issues) if you want to contribute. + +--- + +> [amirdeljouyi](http://ce.sharif.edu/~deljouyi)  ·  +> GitHub [@amirdeljouyi](https://github.com/amirdeljouyi)  ·  +> Twitter [@amirdeljouyi](https://twitter.com/amirdeljouyi) diff --git a/docs/lighthouse.png b/docs/lighthouse.png new file mode 100644 index 0000000..42254ea Binary files /dev/null and b/docs/lighthouse.png differ diff --git a/docs/lighthouse.svg b/docs/lighthouse.svg new file mode 100644 index 0000000..c64a632 --- /dev/null +++ b/docs/lighthouse.svg @@ -0,0 +1,44 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/screenshot.png b/docs/screenshot.png new file mode 100644 index 0000000..fd718d5 Binary files /dev/null and b/docs/screenshot.png differ