Commit d0954d3b authored by Seb's avatar Seb

smaller fixes: typos

parent aca04664
......@@ -38,7 +38,7 @@ npm publish # Now it is time to publish!
> Errare human est
If you have fixed them and want to deploy a new version of your component, run `npm publish` again.
(hint: you need to change version for a new deployment)
(you need to change package version for a new deployment)
{% endhlblock %}
{% alert ok %}
......
......@@ -13,8 +13,8 @@ The modularity and re-usability is one of the key ideas of BioJS. Maybe it helps
(user refers to someone who embeds your application, e.g. a website owner)
* you only have __one div__ (nobody wants to copy HTML that will change over versions, to some extent you could have more for optional user controls)
* a user is allowed to create multiple instances of your app (on the same page)
* a user might want to customize your app by changing some options - he will have its own file and customize the your settings
* a user is allowed to create __multiple__ instances of your app (on the same page)
* a user wants to __customize__ your app by changing some options - he will have its own file and customize the your settings
### This means:
......@@ -24,6 +24,6 @@ The modularity and re-usability is one of the key ideas of BioJS. Maybe it helps
* Consider the div that your application gets as a virtual environment for your component - only modify stuff inside of it
* A user will instantiate your application (=will call your main class with new)
* Don't do crazy shit with document.body or the Function.prototype
* Don't query the entire web page for DOM elements - an ID is unique. So $('#fancyId') won't work and $(".fancyClass") will return you the objects of all instances
* Don't query the entire web page for DOM elements. So the naive jQuery won't work as (1) `$('#fancyId')` and ID unique is and if you switch to classes it `$(".fancyClass")` will return you the objects of all instances
A general advise is to create all the needed DOM elements in your component and save references to the most important ones.
......@@ -7,12 +7,11 @@ permalink: details/conventions/
estimated-time: 5
---
Conventions
General conventions
----------
* [io packages](https://github.com/biojs/biojs/wiki/BioJS-parser)
* visualization:
- [`biojs-events`](https://github.com/biojs/biojs-events): A event system to send events to outside listener
* visualization: [`biojs-events`](https://github.com/biojs/biojs-events): A event system to send events to outside listener
* state your license in your README
* source folder structure: use either `lib` or `src` (the NodeJS convention is to
name it `lib`, but frankly it doesn't matter)
......@@ -75,6 +74,6 @@ If you do disagree with an item listed here, please open an issue on github.
Example components
-----------------
* [biojs-vis-msa](https://github.com/greenify/biojs-vis-msa) (in CoffeeScript)
* [msa](https://github.com/greenify/msa) (in CoffeeScript)
(feel free to add your component here)
......@@ -58,7 +58,7 @@ You might want to save same artifacts.
4. Click on "Build now"
#### 3) Using [drone.io](https://drone.io/)
### 4) Using [drone.io](https://drone.io/)
* new project -> github -> add your project
* choose node
......@@ -85,5 +85,5 @@ There are plenty of fancy badges, here is a list to have a quick start.
~~~
{% alert warn %}
There is no need to add your CI badges to the `package.json` , the BioJS registry will soon automatically recognize existing continuous integration services.
There is no need to add your CI badges to the `package.json`, the BioJS registry will soon automatically recognize existing continuous integration services.
{% endalert %}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment