Skip to content

Commit 0155b85

Browse files
fix: add flow to readme
1 parent 1af5427 commit 0155b85

2 files changed

Lines changed: 15 additions & 7 deletions

File tree

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,12 @@ Current version supports next programming languages:
9191
- and others which use `//` as a comment :)
9292

9393
Please file an issue to support other language you would like to have.
94-
> Note: In current version only JavaScript uses AST parser to process the code, hence it offers more features (e.g. Dependencies tree)
94+
95+
#### Download & Upload (learn and share your knowledge)
96+
97+
You can take a snapshot of application state at any point of time and share it with others. Simply download the json file of codecrumbs store (*top-right corner, "setup -> download"*). This json file can be then uploaded to codecrumbs (*top-right corner, "setup -> upload"*) to represent exactly same picture, even without having that project locally!
98+
99+
<img src="/docs/upload-feature-2.gif" width="100%"/>
95100

96101
#### Dependencies
97102
> Note: In current version only JavaScript offers this feature
@@ -104,24 +109,27 @@ UI explained:
104109
2) Select connection between modules
105110
3) All involved files (two or more) will be opened in "Sidebar", so you can see “what is imported” and “its implementation”.
106111

107-
#### Download & upload (learn and  share your knowledge)
108-
So let’s say you put together some trail of codecrumbs describing some important flow inside the project. How you can share it with others? Simply download the json file of codecrumbs store, send it to the friend, he/she uploads it to the codecrumbs and can see same you just saw!
109-
<img src="/docs/upload-feature-2.gif" width="100%"/>
112+
#### Flowchart
113+
> Note: In current version only JavaScript offers this feature
114+
115+
<img src="/docs/flow-ui.png" width="100%"/>
116+
117+
[js2flowchart](https://github.com/Bogdan-Lyashenko/js-code-to-svg-flowchart) is used in the sidebar to draw flowchart for the selected file code.
110118

111119
## Case studies
112-
The tool (codecrumbs) allows us to learn, document and explain a codebase much faster. Also, with *Download & upload* feature it becomes super easy to collect and share your "investigation results".
120+
The tool (codecrumbs) allows us to learn, document and explain a codebase much faster. Also, with *Download & Upload* feature it becomes super easy to collect and share your "investigation results".
113121

114122
The ultimate goal is to have many case studies hosting at [https://codecrumbs.io](https://codecrumbs.io/). **The library of projects "explained with codecrumbs", the place for collaborative learning**. More features around that coming soon, stay tuned.
115123

116124
## Support
117125
Any support is very much appreciated! 👍 😘 ❤️
118126
If you like this project, please, **put a :star: and tweet about it**. Thanks!
119127

120-
Please, consider [making financial donation](https://opencollective.com/codecrumbs), it will help further development of more cool features! We'll thank you by including your name/company logo here ☺️
128+
Please, consider [making financial donation](https://opencollective.com/codecrumbs), it will help further development of more cool features! We'll thank you by including your name/company logo here ☺️. Feel free to [ping me](https://www.linkedin.com/in/bohdan-liashenko-bb365854/) for discussion.
121129

122130
<a href="https://opencollective.com/codecrumbs/donate" target="_blank">
123131
<img src="https://opencollective.com/codecrumbs/donate/button@2x.png?color=blue" width=300 />
124-
</a>
132+
</a>
125133

126134
## Contribute
127135
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the [owner](https://github.com/Bogdan-Lyashenko/) of this repository before making a change. Ideas and suggestions are welcome.

docs/flow-ui.png

97.2 KB
Loading

0 commit comments

Comments
 (0)