Skip to content
This repository was archived by the owner on Mar 30, 2021. It is now read-only.

Commit 59a0173

Browse files
committed
Updated documentation for arguments feature
1 parent 2bc7ff6 commit 59a0173

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,32 @@ npm install -g yo
2323

2424
Step 2a: Install [generator-biojs-webcomponents](https://www.npmjs.com/package/@biojs/generator-biojs-webcomponents).
2525

26-
Note that below you can change my-new-component to the folder name of your choice. e.g. - your project name.
27-
2826
```bash
29-
mkdir my-new-component
30-
cd my-new-component
31-
npm install -g yo @biojs/generator-biojs-webcomponents
27+
npm install -g yo @biojs/biojs-webcomponents
3228
```
3329

3430
Step 2b: Generate your new project.
3531

36-
```bash
37-
yo @biojs/biojs-webcomponents
3832
```
33+
i) yo @biojs/biojs-webcomponents
34+
```
35+
This will make a new directory named `web-component` in the current directory. The `web-component` directory will be your project directory. If there is already a directory with the name `web-component`, the generator will not make a new one, rather the existing one will be your project directory.
36+
37+
OR
38+
39+
```
40+
ii) yo @biojs/biojs-webcomponents .
41+
```
42+
This will run the generator in the current directory.
43+
44+
OR
45+
46+
```
47+
iii) yo @biojs/biojs-webcomponents /anyPath/yourNewProjectDir
48+
```
49+
This will run the generator in a new directory named `yourNewProjectDir` (you can choose any other name), the new directory will be created at the path you specified. If there is already a directory with the same name as you provided, the generator will not make a new one, rather the existing one will be your project directory.
50+
51+
3952

4053
After running this, you will be asked some questions about the details of your project, after which the required dependencies will be automatically installed. You can read more about the whole workflow and the questions asked [here](#iii-workflow-and-questions).
4154

0 commit comments

Comments
 (0)