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

Commit 165e98f

Browse files
committed
Updated commands in README and released new version
1 parent e4f37e5 commit 165e98f

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

DEV_DOCS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ this.argument("projectDirectory", {
1111
});
1212
```
1313

14-
This defines the project directory argument which is entered when the generator is run. The string value stored in the `desc` above is shown when user runs the command `yo @biojs/biojs-webcomponents --help`. Each argument should have a desc field so that yeoman can provide help when user asks.
14+
This defines the project directory argument which is entered when the generator is run. The string value stored in the `desc` above is shown when user runs the command `yo biojs-webcomponents --help`. Each argument should have a desc field so that yeoman can provide help when user asks.
1515

1616
The methods listed after the `constructor` are default methods provided by yeoman which are executed in the order they are written which is -
1717
### 1. initializing()
@@ -104,7 +104,7 @@ async function(props) {
104104
`Oops! We encountered an error. Please see below for the more details - \n${chalk.yellow(
105105
err
106106
)}\n.Try this - cd into that directory and run ${chalk.cyan(
107-
"`yo @biojs/biojs-webcomponents .`"
107+
"`yo biojs-webcomponents .`"
108108
)}.`
109109
);
110110
});

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,30 +21,30 @@ Step 1: Install [Yeoman](http://yeoman.io).
2121
npm install -g yo
2222
```
2323

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

2626
```
27-
npm install -g yo @biojs/biojs-webcomponents
27+
npm install -g yo generator-biojs-webcomponents
2828
```
2929

3030
Step 2b: Generate your new project.
3131

3232
```
33-
i) yo @biojs/biojs-webcomponents
33+
i) yo biojs-webcomponents
3434
```
3535
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**.
3636

3737
OR
3838

3939
```
40-
ii) yo @biojs/biojs-webcomponents .
40+
ii) yo biojs-webcomponents .
4141
```
4242
This will run the generator in the **current directory**.
4343

4444
OR
4545

4646
```
47-
iii) yo @biojs/biojs-webcomponents /anyPath/yourNewProjectDir
47+
iii) yo biojs-webcomponents /anyPath/yourNewProjectDir
4848
```
4949
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**.
5050

@@ -106,7 +106,7 @@ If you face any issue, feel free to contact us at [Gitter](https://gitter.im/bio
106106

107107
## III. Workflow and Questions
108108

109-
After running ```yo @biojs/biojs-webcomponents``` in your terminal, you will be asked -
109+
After running ```yo biojs-webcomponents``` in your terminal, you will be asked -
110110

111111
```
112112
? Press Enter key to get going!

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "generator-biojs-webcomponents",
3-
"version": "2.0.0",
3+
"version": "2.0.2",
44
"description": "Generate the scaffold for a BioJS component automatically so you don't have to do it yourself",
55
"homepage": "http://biojs.net",
66
"author": {

0 commit comments

Comments
 (0)