-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
fa3305d
commit c18db81
Showing
12 changed files
with
42 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,6 +29,13 @@ Here you should see a bunch of js files. | |
| * `neb-light.js`:Used in Repl console. Not including outside dependency. | ||
| * `nebulas.js`: Fully functional in the browser. Users can create an address, sign a transaction, and deploy/call a smart contract. | ||
|
|
||
| ###### CDN Support | ||
| neb.js has been released to [NPM](https://www.npmjs.com/package/nebulas), and developers can use the following code through [CDN](https://www.jsdelivr.com/package/npm/nebulas) addition. | ||
|
|
||
| ```html | ||
| <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/nebulas.js"></script> | ||
| ``` | ||
|
|
||
| ## Documentation | ||
|
|
||
|
|
||
|
|
@@ -44,20 +51,27 @@ Generated documentation you can check in `/documentation` folder. | |
| * The RPC interface for the nebulas node is encapsulated; | ||
| * Create and manage the private key and address of the nebulas; | ||
| * Generate the transaction object and sign the transaction. | ||
| * Deploy/call smart contract, breakpoint debugging support. | ||
|
|
||
| The use of neb.js can be used as examples: | ||
|
|
||
| * [web-example](example/example.html) | ||
| * [nodejs-example](example/node-example.js) | ||
| * [node-nvm](example/node-nvm.js) | ||
|
|
||
| ## Extra | ||
| Rollup is a module bundler for JavaScript which compiles small pieces of code into something larger and more complex, such as a library or application. | ||
| ## Contribution | ||
|
|
||
| Next step go to the neb.js folder in your Nebulas dir and | ||
| Build neb-node.js by using [rollup](https://rollupjs.org/): | ||
| We are very glad that you are considering to help Nebulas Team or go-nebulas project, including but not limited to source code, documents or others. | ||
|
|
||
| ``` | ||
| rollup -c | ||
| ``` | ||
| If you'd like to contribute, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base. If you wish to submit more complex changes though, please check up with the core devs first on our [slack channel](http://nebulasio.herokuapp.com) to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple. | ||
|
|
||
| Please refer to our [contribution guideline](https://github.com/nebulasio/wiki/blob/master/contribute.md) for more information. | ||
|
|
||
| Thanks. | ||
|
|
||
| ## License | ||
|
|
||
| The go-nebulas project is licensed under the [GNU Lesser General Public License Version 3.0 (“LGPL v3”)](https://www.gnu.org/licenses/lgpl-3.0.en.html). | ||
|
|
||
| For the more information about licensing, please refer to [Licensing](https://github.com/nebulasio/wiki/blob/master/licensing.md) page. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -107,24 +107,29 @@ <h2>Install && Package</h2><p>Use the <code>npm</code> installation depe | |
| <li><code>neb-light.js</code>:Used in Repl console. Not including outside dependency.</li> | ||
| <li><code>nebulas.js</code>: Fully functional in the browser. Users can create an address, sign a transaction, and deploy/call a smart contract.</li> | ||
| </ul> | ||
| <h2>Documentation</h2><p><a target="_blank" href="https://nebulasio.github.io/neb.js/index.html">Public API documentation link</a></p> | ||
| <h6>CDN Support</h6><p>neb.js has been released to <a href="https://www.npmjs.com/package/nebulas">NPM</a>, and developers can use the following code through <a href="https://www.jsdelivr.com/package/npm/nebulas">CDN</a> addition.</p> | ||
| <pre class="prettyprint source lang-html"><code><script src="https://cdn.jsdelivr.net/npm/[email protected]/nebpay.min.js"></script></code></pre><h2>Documentation</h2><p><a target="_blank" href="https://nebulasio.github.io/neb.js/index.html">Public API documentation link</a></p> | ||
| <p>For build API documentation run <code>gulp documentation</code> task.</p> | ||
| <p>Generated documentation you can check in <code>/documentation</code> folder.</p> | ||
| <h2>Usage</h2><p><code>neb.js</code> is a useful library for nebulas developers. It provides rich underlying support in web and node.js's dapp. It implements the following functions.</p> | ||
| <ul> | ||
| <li>The RPC interface for the nebulas node is encapsulated;</li> | ||
| <li>Create and manage the private key and address of the nebulas;</li> | ||
| <li>Generate the transaction object and sign the transaction.</li> | ||
| <li>Deploy/call smart contract, breakpoint debugging support.</li> | ||
| </ul> | ||
| <p>The use of neb.js can be used as examples:</p> | ||
| <ul> | ||
| <li><a href="example/example.html">web-example</a> </li> | ||
| <li><a href="example/node-example.js">nodejs-example</a></li> | ||
| <li><a href="example/node-nvm.js">node-nvm</a></li> | ||
| </ul> | ||
| <h2>Extra</h2><p>Rollup is a module bundler for JavaScript which compiles small pieces of code into something larger and more complex, such as a library or application.</p> | ||
| <p>Next step go to the neb.js folder in your Nebulas dir and | ||
| Build neb-node.js by using <a href="https://rollupjs.org/">rollup</a>:</p> | ||
| <pre class="prettyprint source"><code>rollup -c</code></pre></article> | ||
| <h2>Contribution</h2><p>We are very glad that you are considering to help Nebulas Team or go-nebulas project, including but not limited to source code, documents or others.</p> | ||
| <p>If you'd like to contribute, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base. If you wish to submit more complex changes though, please check up with the core devs first on our <a href="http://nebulasio.herokuapp.com">slack channel</a> to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.</p> | ||
| <p>Please refer to our <a href="https://github.com/nebulasio/wiki/blob/master/contribute.md">contribution guideline</a> for more information.</p> | ||
| <p>Thanks.</p> | ||
| <h2>License</h2><p>The go-nebulas project is licensed under the <a href="https://www.gnu.org/licenses/lgpl-3.0.en.html">GNU Lesser General Public License Version 3.0 (“LGPL v3”)</a>.</p> | ||
| <p>For the more information about licensing, please refer to <a href="https://github.com/nebulasio/wiki/blob/master/licensing.md">Licensing</a> page.</p></article> | ||
| </section> | ||
|
|
||
|
|
||
|
|
@@ -175,7 +180,7 @@ <h4 class="modal-title">Search results</h4> | |
| <span class="jsdoc-message"> | ||
| Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> | ||
|
|
||
| on 2018-06-13T15:15:02+08:00 | ||
| on 2018-06-13T16:16:04+08:00 | ||
|
|
||
| using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. | ||
| </span> | ||
|
|
||
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| { | ||
| "version": "0.5.0" | ||
| "version": "0.5.1" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters