isoflow/README.md

36 lines
1.2 KiB
Markdown
Raw Normal View History

2023-03-08 20:33:47 +00:00
![readme-header](https://user-images.githubusercontent.com/1769678/223572353-788d5d38-cd28-40fa-96cd-9d29226f7e4b.png)
<div align="center">
![GitHub License MIT](https://img.shields.io/github/license/wbkd/react-flow?color=%23ff0072)
A highly customizable React component for building interactive flow diagrams.
Coming soon under the MIT licence | Use it now on [isoflow.io](https://isoflow.io)
</div>
## Key Features
- **Real-time:** Display real-time data on diagrams.
- **Customizable:** Use your own isometric icon packs, or use our free set of networking icons (also under MIT).
- **Export options:** Export diagrams as images, JSON or YAML.
- **Powerful annotation tools:** Annotate nodes, groups and connectors.
- **Step-by-step walkthroughs:** Create interactive tours of large diagrams to help viewers easily digest information.
2023-03-16 23:19:31 +00:00
## Roadmap
Migration to open-source: ██░░░░░░░░░
- [x] Set up automated publishing to NPM registry
- [ ] Migrate private JS project to public Typescript project
2023-03-22 21:10:13 +00:00
- [ ] Pan / Select / Zoom modes
- [ ] Icons
- [ ] Groups
- [ ] Connectors
2023-03-16 23:19:31 +00:00
- [ ] Publish icons as separate importable package
2023-03-08 20:33:47 +00:00
## License
2023-03-16 23:19:31 +00:00
Isoflow is MIT licensed (see ./LICENSE).