mirrors/isoflow
1
0
Fork 0
mirror of https://github.com/markmanx/isoflow.git synced 2025-02-08 04:18:29 +00:00
Code Issues Projects Releases Packages 2 Wiki Activity Actions

chore: updates README

Browse source
This commit is contained in:
Mark Mankarious 2023-08-28 23:36:03 +01:00
parent 1f67c297fb
commit d0cf739e04
1 changed files with 7 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -2,6 +2,7 @@
<h4 align="center"> <h4 align="center">
<a href="https://codesandbox.io/p/sandbox/github/markmanx/isoflow">Isoflow Editor</a> | <a href="https://codesandbox.io/p/sandbox/github/markmanx/isoflow">Isoflow Editor</a> |
<a href="https://v2.isoflow.io/docs">Documentation</a> |
<a href="https://github.com/markmanx/isoflow">Github</a> | <a href="https://github.com/markmanx/isoflow">Github</a> |
<a href="https://discord.gg/QYPkvZth7D">Discord</a> <a href="https://discord.gg/QYPkvZth7D">Discord</a>
</h4> </h4>
@ -25,19 +26,18 @@
## Roadmap ## Roadmap
V1 release progress: █████████░ v1 progress: █████████░
- [x] Basic view controls (pan & zoom) - [x] Basic view controls (pan & zoom)
- [x] Create / delete nodes - [x] Create / delete nodes
- [x] Create / delete connectors - [x] Create / delete connectors
- [x] Create / delete rectangle areas - [x] Create / delete rectangle areas
- [x] Node icons (e.g. server, router etc) - [x] Generic networking icons (e.g. server, router etc)
- [ ] Cloud service icons (i.e. AWS + GCP icons)
- [x] onSceneUpdate callback - [x] onSceneUpdate callback
- [x] Drag items - [x] Drag items
- [x] Documentation - [x] Documentation
- [x] Load / save diagram (locally as JSON) - [x] Load / save diagrams locally as JSON
- [ ] Cloud service icons (i.e. AWS + GCP icons)
## Quick start ## Quick start
@ -87,13 +87,12 @@ To run Isoflow on a local development server with hot-reloading enabled:
2. `npm run start`. 2. `npm run start`.
## Developer documentation ## Developer documentation
For detailed API documentation, examples and more, see the online [developer documentation](https://v2.isoflow.io/docs). Or if you'd prefer to build and run the docs locally: For detailed API documentation, examples and more, see the online [developer documentation](https://v2.isoflow.io/docs). You can also build and run the docs locally:
- `npm run start:docs` - `npm run start:docs`
## CodeSandbox ## CodeSandbox
Demo the latest version of Isoflow on [CodeSandbox](https://codesandbox.io/p/sandbox/github/markmanx/isoflow/tree). The sandbox will always be synced with the `main` branch on the Github repo, and also includes the latest version of the developer documentation.
You can demo the latest version of Isoflow on [CodeSandbox](https://codesandbox.io/p/sandbox/github/markmanx/isoflow/tree). The sandbox is always synced with the Github repo.
## Contributing ## Contributing
- Isoflow is actively being worked on. Missing something or found a bug? Report it [here](https://github.com/markmanx/isoflow/issues) or join our [Discord server](https://discord.gg/QYPkvZth7D). - Isoflow is actively being worked on. Missing something or found a bug? Report it [here](https://github.com/markmanx/isoflow/issues) or join our [Discord server](https://discord.gg/QYPkvZth7D).