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

Commit b19f225

Browse files
committed
Merge branch 'master' of github.com:biojs/generator-biojs-webcomponents
2 parents 2c80627 + 5ad36ba commit b19f225

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
11
# generator-biojs-webcomponents [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]
2-
> Generate the scaffold for a BioJS component automatically so you don't hav to do it yourself
2+
Generates the scaffold for a BioJS component automatically so you don't have to do it yourself. This is also specifically designed with re-packaging existing components in mind, so you can upgrade to BioJS 3 component style without having to re-write your component.
33

4-
## Installation
54

6-
First, install [Yeoman](http://yeoman.io) and generator-biojs-webcomponents using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
5+
6+
## Getting started.
7+
8+
First, install [Yeoman](http://yeoman.io) and generator-biojs-webcomponents using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)) - if you need to manage multiple versions of node also consider [nvm](https://github.com/creationix/nvm).
9+
10+
Once node is installed, run this in your terminal.
11+
12+
Note that below you can change my-new-component to the folder name of your choice.
713

814
```bash
9-
npm install -g yo
10-
npm install -g generator-biojs-webcomponents
15+
mkdir my-new-component
16+
cd my-new-component
17+
npm install -g yo @biojs/generator-biojs-webcomponents
1118
```
1219

1320
Then generate your new project:
@@ -16,17 +23,17 @@ Then generate your new project:
1623
yo @biojs/biojs-webcomponents
1724
```
1825

19-
## Getting To Know Yeoman
26+
This will walk you through the process of setting up your component and generate boilerplate files for you.
27+
Once it's complete, look at your new README file for build instructions, and check out `src/index.js`
28+
and `examples/index.html` to get started - there are instructions in the code.
2029

21-
* Feel free to [learn more about Yeoman](http://yeoman.io/).
2230

2331
## License
2432

2533
MIT © [Yo Yehudi](http://www.yo-yehudi.com)
2634

27-
28-
[npm-image]: https://badge.fury.io/js/generator-biojs-webcomponents.svg
29-
[npm-url]: https://npmjs.org/package/generator-biojs-webcomponents
35+
[npm-image]: https://badge.fury.io/js/%40biojs%2Fgenerator-biojs-webcomponents.svg
36+
[npm-url]: https://npmjs.org/package/%40biojs%2Fgenerator-biojs-webcomponents
3037
[travis-image]: https://travis-ci.org/biojs/generator-biojs-webcomponents.svg?branch=master
3138
[travis-url]: https://travis-ci.org/biojs/generator-biojs-webcomponents
3239
[daviddm-image]: https://david-dm.org/biojs/generator-biojs-webcomponents.svg?theme=shields.io

0 commit comments

Comments
 (0)