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

Commit 2c80627

Browse files
committed
add more notes to todo file.
1 parent 39df0e8 commit 2c80627

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

generators/app/templates/TODO.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,18 @@ produced the basic files needed for your tool. You'll still need to handle the i
66
## Todos before this is release-ready:
77

88
- [] edit [src/index.js](src/index.js) and add code to initialise your tool
9-
- [] update examples/index.html to show a demo of your tool
9+
- [] update [examples/index.html](examples/index.html) to show a demo of your tool
1010
- [] add `preview.png` to the root directory of this repo. This image will be used to preview your tool.
1111
- [] update your tool's description in [README.md](README.md)
1212
- [] edit package.json and point to your github repository, something like ``` "repository": {
1313
"type": "git",
1414
"url": "[email protected]:yourGitHubUser/someRepo.git"
1515
},```
1616
- [] add any css styles to [src/style.less](src/style.less)
17+
18+
All those done? Brilliant! To push this component to npm, you'll need an [account at npmjs.com](https://www.npmjs.com/). Once you've signed up....
19+
20+
1. Run `npm login` in your terminal to sign in to npm. Add your username and password when prompted.
21+
2. Run `npm publish` - this step will publish your app onto the public npm repository.
22+
23+
That's it. Congratulations - you've published your first BioJS component! The registry is updated once a day, so it might be a few hours or up to a day before your component appears.

0 commit comments

Comments
 (0)