Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
amirdeljouyi committed Jan 14, 2021
1 parent 97e8116 commit 7972a17
Show file tree
Hide file tree
Showing 4 changed files with 121 additions and 1 deletion.
78 changes: 77 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,77 @@
# icely-activitystorming
<h1 align="center">
<br>
<a href="https://github.com/IcelyFramework/icely-activity-storming"><img src="docs/lighthouse.png" alt="Icely Activity Storming" width="200"></a>
<br>
Icely Activity Storming
<br>
</h1>

<h4 align="center">A Modeling Tool and metamodel for explore, visualize, design, formalize business domain.</h4>

<p align="center">
<img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/IcelyFramework/icely-activity-storming">
<img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/IcelyFramework/icely-activity-storming">
<img alt="GitHub" src="https://img.shields.io/github/license/IcelyFramework/icely-activity-storming">
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/IcelyFramework/icely-activity-storming?style=social">
</p>

<p align="center">
<a href="#about">About</a> •
<a href="#user-content--key-features">Key Features</a> •
<a href="#user-content--how-to-use">How To Use</a> •
<a href="#user-content--roadmap">Roadmap</a> •
<a href="#user-content--contributing">Contributing</a> •
<a href="#license">License</a>
</p>

![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

<a href="https://www.buymeacoffee.com/amirdeljouyi" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/purple_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>

## 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) &nbsp;&middot;&nbsp;
> GitHub [@amirdeljouyi](https://github.com/amirdeljouyi) &nbsp;&middot;&nbsp;
> Twitter [@amirdeljouyi](https://twitter.com/amirdeljouyi)
Binary file added docs/lighthouse.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 44 additions & 0 deletions docs/lighthouse.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7972a17

Please sign in to comment.