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

Commit 82c42ba

Browse files
Merge pull request #27 from Nikhil-Vats/update_templates
Updated README file in templates
2 parents bca40e5 + 482ce8d commit 82c42ba

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

generators/app/templates/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,10 @@ Where you want your WebComponent to appear, add the following:
2626

2727
Some notes on usage:
2828

29-
- `geneId` value must must be an identifier for a gene. You can replace it
30-
with your favourite gene id instead!
29+
- Download the bundle.js file from dist folder and link it to your index.html file.
30+
- You may use the style.css in dist folder file for styling the component.
31+
- Use the <<%= toolNameComputer %> element like any other HTML element wherever you want.
32+
- `attribute` must be a valid identifier with a valid `value`.
3133

3234

3335
## Licence
@@ -40,7 +42,7 @@ with your favourite gene id instead!
4042
1. Clone the repo
4143
2. `cd <%= toolNameComputer %>` and then `npm install` to install dependencies.
4244

43-
All of the editable source files for css and js are in `src`. To bundle for prod, run the following commands:
45+
All of the editable source files for css and js are in `src`. To bundle for prod, run the following commands in the given order:
4446

4547
#### CSS
4648

@@ -72,6 +74,6 @@ To serve your page at [http://localhost:3456](http://localhost:3456):
7274
```bash
7375
npm run server
7476
```
75-
#### Example comonent
77+
#### Example component
7678
To see a demo component implemented similarly to this component, visit
7779
[biojs-webcomponent-prototype](https://github.com/yochannah/biojs-webcomponent-prototype).

0 commit comments

Comments
 (0)