core.js: Adding reference to Browserify, tutorials and moving usage
section to be before Building and testing
Change-Id: Ie8f8f73ed935b33e2cbfbef7a68e6a52364e486a
diff --git a/README.md b/README.md
index 5d8e94b..c77ae12 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,31 @@
npm install --save git@github.com:vanadium/js.git
+## Usage
+
+Documentation for this API is available at https://jsdoc.v.io/
+Tutorials can be found at https://v.io/tutorials/javascript/
+
+The entry point to the API is through a module called `vanadium`, everything
+else is considered private and should not be accessed by the users of the API.
+
+The `vanadium` module is exported as a global in the browser JavaScript library and for
+[Browserify] and [Node.js] the "main" property in the `package.json` points to `/src/vanadium` making it the index module and therefore [Browserify] and [Node.js] users can gain access to the API with:
+
+ var vanadium = require("vanadium");
+
+One of the goals of this project is to only write the code once and have it run
+in both [Node.js] and browsers. Therefore, specific build and testing steps
+have been designed in the project to ensure this goal.
+
+When run in a browser, `vanadium.js` expects that the [vanadium
+extension](https://v.io/tools/vanadium-chrome-extension.html) will be
+installed.
+
+## Bugs and feature requests
+
+Bugs and feature requests should be filed in the [Vanadium issue tracker](https://github.com/vanadium/issues/issues).
+
## Building and testing
GNU Make is used to build and test [Vanadium].
@@ -32,33 +57,9 @@
make test-integration-browser
Remove all build and testing artifacts:
-
+
make clean
-## Usage
-
-Documentation for this API is available at https://jsdoc.v.io/
-
-The entry point to the API is through a module called `vanadium`, everything
-else is considered private and should not be accessed by the users of the API.
-
-The `vanadium` module is exported as a global in the browser JavaScript library and for
-[Node.js] the "main" property in the `package.json` points to `/src/vanadium` making
-it the index module and therefore [Node.js] users can gain access to the API with:
-
- var vanadium = require("vanadium");
-
-One of the goals of this project is to only write the code once and have it run
-in both [Node.js] and browsers. Therefore, specific build and testing steps
-have been designed in the project to ensure this goal.
-
-When run in a browser, `vanadium.js` expects that the [vanadium
-extension](https://v.io/tools/vanadium-chrome-extension.html) will be
-installed.
-
-## Bugs and feature requests
-
-Bugs and feature requests should be filed in the [Vanadium issue tracker](https://github.com/vanadium/issues/issues).
-
[Vanadium]: https://v.io/
[Node.js]: https://nodejs.org/
+[Browserify]: http://browserify.org/
diff --git a/jsdocs/index.md b/jsdocs/index.md
index 3050198..6883d78 100644
--- a/jsdocs/index.md
+++ b/jsdocs/index.md
@@ -10,4 +10,4 @@
[init](module-vanadium.html#.init) function, defines entry points to create servers, client, blessing and other Vanadium functionality.
##Tutorials
-Please visit tutorials section of [v.io website](https://www.v.io/tutorials/javascript/overview.html) for JavaScript tutorials.
\ No newline at end of file
+Please visit tutorials section of [v.io website](https://v.io/tutorials/javascript/) for JavaScript tutorials.
\ No newline at end of file