version 0.1.0 -- docs, config, util

Author: SilentCicero

README.md

@@ -76,14 +76,12 @@ intToHex             <Function (Number) : (String)>
 
 Please help better the ecosystem by submitting issues and pull requests to default. We need all the help we can get to build the absolute best linting standards and utilities. We follow the AirBNB linting standard and the unix philosophy.
 
-<!--
 ## Guides
 
-You'll find more detailed information on using default and tailoring it to your needs in our guides:
+You'll find more detailed information on using `ethjs-util` and tailoring it to your needs in our guides:
 
 - [User guide](docs/user-guide.md) - Usage, configuration, FAQ and complementary tools.
-- [Developer guide](docs/developer-guide.md) - Contributing to wafr and writing your own plugins & formatters.
--->
+- [Developer guide](docs/developer-guide.md) - Contributing to `ethjs-util` and writing your own code and coverage.
 
 ## Help out
 

dist/ethjs-util.js

@@ -0,0 +1,30 @@
+# Documentation
+
+## Table of Contents
+
+- [General](general)
+  - [**Developer Guide**](developer-guide.md)
+  - [**User Guide**](user-guide.md)
+
+## Overview
+
+### Structure
+
+The [`src/`](../../../tree/master/src) directory contains your entire application code, including JavaScript, and tests.
+
+The rest of the folders and files only exist to make your life easier, and
+should not need to be touched.
+
+For more in-depth structure, see the developer-guide.md.
+
+*(If they do have to be changed, please [submit an issue](https://github.com/ethjs/ethjs-util/issues)!)*
+
+### Testing
+
+For a thorough explanation of the testing procedure, see the
+[testing documentation](./developer-guide/README.md)!
+
+#### Unit testing
+
+Unit tests live in `src/tests/` directories right next to the components being tested
+and are run with `npm test`.

dist/ethjs-util.js.map

@@ -0,0 +1,107 @@
+# Developer Guide
+
+All information regarding contributing to and progressing `ethjs-util` module can be found in this document.
+
+## Install
+
+```
+npm install --save ethjs-util
+```
+
+## Install from Source
+
+```
+git clone http://github.com/ethjs/ethjs-util
+npm install
+```
+
+## Test
+
+```
+npm test
+```
+
+## Build
+
+```
+npm run build
+```
+
+## Linting
+
+```
+npm run lint
+```
+
+## Travis-ci and Coveralls Testing
+
+Note, this will generate a `coveralls` report locally.
+
+```
+npm run test-travis
+```
+
+You can find the coveralls report and view the percentages and stats, by going to the [index.html](coverage/lcov-report/index.html) file generated after running the `test-travis` script. Open this in Chrome to see the generated report. Travis will run mocha as usual, but collect information about the testing coverage. This report will be sent by TravisCI during the automated build process.
+
+## Build Staging
+
+The build staging for this module is as follows:
+
+ 1. Cleanup
+ 2. Linting
+ 3. Testing
+ 4. Babel processing (output to lib)
+ 5. Webpack (output to dist)
+ 6. Webpack production (output to dist)
+ 7. Retest lib folder for babel processing solidity
+ 8. Report build stats
+
+## Folder Structure
+
+All module source code is found in the `src` directory. All module helper scripts can be found in the `scripts` folder. These will not need to be touched, and are purely configuration for this repository.
+
+```
+./ethjs-util
+  ./.github
+  ./dist
+  ./lib
+    ./tests
+  ./internals
+    ./webpack
+  ./coverage
+  ./docs
+  ./src
+    ./tests
+```
+
+Note, the `./lib` dir is generated from the babel build staging. `./coverage` is generated from the `npm run test-travis` script. All internals and helper scripts (i.e. `webpack`) are in `./internals`. All distribution builds are in `./dist` (usually a minified and unminified production build of the package).
+
+## NPM Practice
+
+Across all `ethjs-` repos, we enforce version hardening (i.e. "0.0.3" not "^0.0.3"). We want to reduce potential hazardous install changes from dependancies as much as possible to ensure package preformace, testing, security and design. Please make sure all your commits and PR's are version hardend if you are installing or removing new packages.
+
+After build staging it is the `lib` folder which actually gets published to NPM. This allows for easy inclusion into other modules which may not use babel transpiling or which may not support es2015+.
+
+## NPM/Node Version Requirements
+
+`ethjs` requires you have:
+  - `nodejs` -v 6.5.0+
+  - `npm` -v 3.0+
+
+This is a requirement to run, test, lint and build this module.
+
+## Changelog
+
+All relevant changes are notated in the `CHANGELOG.md` file, moniter this file for changes to this repository.
+
+## Travis-ci and Coveralls Practice
+
+Across all `ethjs-` repos, we enforce mandatory travis-ci and coveralls testing. We never `commit to master`. As a general policy, Coveralls.io results must always be above 95% for any `ethjs-` PR or commit. We want to ensure complete coverage across the board.
+
+## Contributing
+
+Please help better the ecosystem by submitting issues and pull requests. We need all the help we can get to build the absolute best linting standards and utilities. We follow the AirBNB linting standard. Please read more about contributing to `ethjs-util` in the `.github/CONTRIBUTING.md`.
+
+## Licence
+
+This project is licensed under the MIT license, Copyright (c) 2016 Nick Dodson. For more information see LICENSE.

docs/README.md

@@ -0,0 +1,66 @@
+# User Guide
+
+All information for developers using `ethjs-util` should consult this document.
+
+## Install
+
+```
+npm install --save ethjs-util
+```
+
+## Usage
+
+```js
+const util = require('ethjs-util');
+
+const value = util.intToBuffer(38272);
+
+// returns <Buffer ...>
+```
+
+## Available Methods
+
+```
+arrayContainsArray   <Function (Array, Array) : (Boolean)>
+getBinarySize        <Function (String) : (Number)>
+toBuffer             <Function (String) : (Buffer)>
+intToBuffer          <Function (Number) : (Buffer)>
+isHexPrefixed        <Function (String) : (Boolean)>
+stripHexPrefix       <Function (String) : (String)>
+padToEven            <Function (String) : (String)>
+intToHex             <Function (Number) : (String)>
+```
+
+## Browser Builds
+
+`ethjs` provides production distributions for all of its modules that are ready for use in the browser right away. Simply include either `dist/ethjs-util.js` or `dist/ethjs-util.min.js` directly into an HTML file to start using this module. Note, an `ethUtil` object is made available globally.
+
+```html
+<script type="text/javascript" src="ethjs-util.min.js"></script>
+<script type="text/javascript">
+ethUtil(...);
+</script>
+```
+
+Note, even though `ethjs` should have transformed and polyfilled most of the requirements to run this module across most modern browsers. You may want to look at an additional polyfill for extra support.
+
+Use a polyfill service such as `Polyfill.io` to ensure complete cross-browser support:
+https://polyfill.io/
+
+## Other Awesome Modules, Tools and Frameworks
+
+ - [web3.js](https://github.com/ethereum/web3.js) -- the original Ethereum swiss army knife **Ethereum Foundation**
+ - [ethereumjs](https://github.com/ethereumjs) -- critical ethereumjs infrastructure **Ethereum Foundation**
+ - [browser-solidity](https://ethereum.github.io/browser-solidity) -- an in browser Solidity IDE **Ethereum Foundation**
+ - [wafr](https://github.com/silentcicero/wafr) -- a super simple Solidity testing framework
+ - [truffle](https://github.com/ConsenSys/truffle) -- a solidity/js dApp framework
+ - [embark](https://github.com/iurimatias/embark-framework) -- a solidity/js dApp framework
+ - [dapple](https://github.com/nexusdev/dapple) -- a solidity dApp framework
+ - [chaitherium](https://github.com/SafeMarket/chaithereum) -- a JS web3 unit testing framework
+ - [contest](https://github.com/DigixGlobal/contest) -- a JS testing framework for contracts
+
+## Our Relationship with Ethereum & EthereumJS
+
+ We would like to mention that we are not in any way affiliated with the Ethereum Foundation or `ethereumjs`. However, we love the work they do and work with them often to make Ethereum great! Our aim is to support the Ethereum ecosystem with a policy of diversity, modularity, simplicity, transparency, clarity, optimization and extensibility.
+
+ Many of our modules use code from `web3.js` and the `ethereumjs-` repositories. We thank the authors where we can in the relevant repositories. We use their code carefully, and make sure all test coverage is ported over and where possible, expanded on.

docs/developer-guide.md

@@ -1,6 +1,8 @@
 var webpack = require('webpack'); // eslint-disable-line
 
 var env = process.env.NODE_ENV;   // eslint-disable-line
+var filename = 'ethjs-util';      // eslint-disable-line
+var library = 'ethUtil';          // eslint-disable-line
 var config = {                    // eslint-disable-line
   module: {
     loaders: [
@@ -17,13 +19,14 @@ var config = {                    // eslint-disable-line
   },
   devtool: 'cheap-module-source-map',
   output: {
-    library: 'ethUtil',
+    path: 'dist',
+    filename: filename + '.js',       // eslint-disable-line
+    library: library,                 // eslint-disable-line
     libraryTarget: 'umd',
     umdNamedDefine: true,
   },
   plugins: [
     new webpack.BannerPlugin({ banner: ' /* eslint-disable */ ', raw: true, entryOnly: true }),
-    new webpack.BannerPlugin({ banner: ' /* eslint-disable */ ', raw: true }),
     new webpack.optimize.OccurrenceOrderPlugin(),
     new webpack.DefinePlugin({
       'process.env.NODE_ENV': JSON.stringify(env),
@@ -32,6 +35,7 @@ var config = {                    // eslint-disable-line
 };
 
 if (env === 'production') {
+  config.output.filename = filename + '.min.js'; // eslint-disable-line
   config.plugins
   .push(new webpack.optimize.UglifyJsPlugin({
     compressor: {

docs/user-guide.md

@@ -1,6 +1,6 @@
 {
   "name": "ethjs-util",
-  "version": "0.0.5",
+  "version": "0.1.0",
   "description": "A simple set of Ethereum JS utilties.",
   "main": "./lib/index.js",
   "scripts": {
@@ -11,8 +11,8 @@
     "prebuild": "npm run build:clean && npm run test",
     "build:clean": "npm run test:clean && rimraf ./dist",
     "build:commonjs": "cross-env BABEL_ENV=commonjs babel src --out-dir lib --copy-files",
-    "build:umd": "cross-env BABEL_ENV=commonjs NODE_ENV=development webpack --config ./internals/webpack/webpack.config.js ./lib/index.js ./dist/ethjs-util.js",
-    "build:umd:min": "cross-env BABEL_ENV=commonjs NODE_ENV=production webpack --config ./internals/webpack/webpack.config.js ./lib/index.js ./dist/ethjs-util.min.js",
+    "build:umd": "cross-env BABEL_ENV=commonjs NODE_ENV=development webpack --config ./internals/webpack/webpack.config.js ./lib/index.js --progress",
+    "build:umd:min": "cross-env BABEL_ENV=commonjs NODE_ENV=production webpack --config ./internals/webpack/webpack.config.js ./lib/index.js --progress",
     "build": "npm run build:commonjs && npm run test:lib && npm run build:umd && npm run build:umd:min",
     "lint": "npm run lint:js",
     "lint:eslint": "eslint --ignore-path .gitignore --ignore-pattern **/**.min.js",
@@ -116,8 +116,8 @@
     "bignumber.js": "3.0.1",
     "bn.js": "4.11.6",
     "chai": "3.5.0",
-    "coveralls": "2.11.9",
     "eslint": "2.10.1",
+    "coveralls": "2.11.9",
     "eslint-config-airbnb": "9.0.1",
     "eslint-import-resolver-webpack": "0.2.4",
     "eslint-plugin-import": "1.8.0",