You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-7Lines changed: 15 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -91,7 +91,12 @@ Current version supports next programming languages:
91
91
- and others which use `//` as a comment :)
92
92
93
93
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!
> Note: In current version only JavaScript offers this feature
@@ -104,24 +109,27 @@ UI explained:
104
109
2) Select connection between modules
105
110
3) All involved files (two or more) will be opened in "Sidebar", so you can see “what is imported” and “its implementation”.
106
111
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!
> Note: In current version only JavaScript offers this feature
114
+
115
+
<imgsrc="/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.
110
118
111
119
## 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".
113
121
114
122
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.
115
123
116
124
## Support
117
125
Any support is very much appreciated! 👍 😘 ❤️
118
126
If you like this project, please, **put a :star: and tweet about it**. Thanks!
119
127
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.
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.
0 commit comments