File tree Expand file tree Collapse file tree 1 file changed +23
-9
lines changed Expand file tree Collapse file tree 1 file changed +23
-9
lines changed Original file line number Diff line number Diff line change 2121
2222### Installation
2323
24- <!-- doc-gen INSTALL global=true -->
25- ``` bash
26- npm install -g repo-description
27- ```
24+ - Install * globally* , making ` repo-describer ` available as a CLI on any path on your system:
2825
29- ``` bash
30- yarn add -g repo-description
31- ```
32- <!-- end-doc-gen -->
26+ <!-- doc-gen INSTALL global=true -->
27+ ``` bash
28+ npm install -g repo-description
29+ ```
30+
31+ ` ` ` bash
32+ yarn add -g repo-description
33+ ` ` `
34+ < ! -- end-doc-gen -->
35+
36+ - Install * locally* in your repository, ready to use in your code.
37+
38+ < ! -- doc-gen INSTALL -->
39+ ` ` ` bash
40+ npm install repo-description
41+ ` ` `
42+
43+ ` ` ` bash
44+ yarn add repo-description
45+ ` ` `
46+ < ! -- end-doc-gen -->
3347
3448# ## Usage
3549
@@ -285,7 +299,7 @@ repo-description/
285299├── md.config.js (438 B) # configure markdown-magic settings for automated documentation updates.
286300├── package-lock.json (297.6 KB) # lock exact versions of installed npm dependencies.
287301├── package.json (3.1 KB) # define project metadata, dependencies, and npm scripts.
288- ├── README.md (17.4 KB) # introduce the project, its purpose, features, and usage instructions.
302+ ├── README.md (17.7 KB) # introduce the project, its purpose, features, and usage instructions.
289303└── RULES_OF_CONDUCT.md (4.9 KB) # establish community standards and expected behavior for contributors.
290304` ` `
291305< ! -- end-doc-gen -->
You can’t perform that action at this time.
0 commit comments