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
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,14 +31,14 @@ Check out the example of [**standalone version running here**](https://codecrumb
31
31
<imgsrc="/docs/main-ui.png"width="100%"/>
32
32
33
33
## Get started
34
-
####Install and run
34
+
### Install and run
35
35
>Pre-condition: update/install `NodeJS` version to be >= *8.11.1*
36
36
37
37
1) Install ```codecrumbs``` to *devDependencies* (```yarn add codecrumbs -D```)
38
38
2) Run ```codecrumbs -d project-src-dir -e project-src-dir/index.js```. Change parameters to match your project:```-d``` is *directory with source code*, ```-e``` is *entry point file* .
39
39
3) Go to [http://localhost:2018](http://localhost:2018/#) in the browser to check it out.
40
40
41
-
####CLI
41
+
### CLI
42
42
Parameter | Description | Example
43
43
--- | --- | ---
44
44
```-e```, ```--entry``` | Path to project source entry point file | ```-e src/app.js```
@@ -48,7 +48,7 @@ Parameter | Description | Example
48
48
```-f```, ```--parserFallback``` | AST parser fallback, applicable only for JavaScript project, use it when @babel-parse fails (optional, default *false*) | ```-f true```
49
49
50
50
## Features
51
-
####Breadcrumbs and trail of breadcrumbs
51
+
### Breadcrumbs and trail of breadcrumbs
52
52
53
53
<imgsrc="/docs/cc-ui.png"width="750"/>
54
54
@@ -71,7 +71,7 @@ Example | Description | Use case
71
71
72
72
> Note: current version supports single line comments only.
73
73
74
-
####Multi-codebase integration
74
+
### Multi-codebase integration
75
75
You might be interested to study connections between several codebases (sub-modules), codecrumbs supports that.
76
76
Simply start codecrumbs multiple times (once for each codebase), it all **will be synced in one picture** inside the browser tab. To control a diagram UI - select it by clicking on it :)
77
77
@@ -80,7 +80,7 @@ E.g. for server-client application, go to the source directory for your server c
80
80
81
81
<imgsrc="/docs/multi-l-c.png"width="100%"/>
82
82
83
-
####Multi-language support
83
+
### Multi-language support
84
84
Current version supports next programming languages:
85
85
-`javascript`
86
86
-`typescript`
@@ -92,13 +92,13 @@ Current version supports next programming languages:
92
92
93
93
Please file an issue to support other language you would like to have.
94
94
95
-
####Download & Upload (learn and share your knowledge)
95
+
### Download & Upload (learn and share your knowledge)
96
96
97
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!
0 commit comments