bdsm
==========

Bad ass client side mocking solution

Getting Started
-----------------

1. Install Node.js:
    - From [nodejs.org](https://nodejs.org/) (All platforms)
    - Or using [Homebrew](http://blog.teamtreehouse.com/install-node-js-npm-mac) (Mac)
    - Or any other [package manager](https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager)
1. Clone the repo
1. Install dependencies (at the root of the repo):

    ```
    npm install
    ```

1. Run the project

    ```
    npm start
    ```

1. Build for deployment

    ```
    npm run build
    ```

1. Build for deployment (Windows only)

    ```
    npm run buildwin
    ```

Version Bump
-------------

- See [Bump a package version](https://docs.npmjs.com/cli/version)

bdsm
==========

Bad ass client side mocking solution

Using BDSM in your project
--------------------------

Add to your packages:

    npm install bdsmjs --save

Require in your app:

    import 'bdsmjs';

Once you reload the application, the BDSM logo will appear in bottom
right corner.

Enjoy!   


Contributing to BDSM
--------------------

1. Install Node.js:
    - From [nodejs.org](https://nodejs.org/) (All platforms)
    - Or using [Homebrew](http://blog.teamtreehouse.com/install-node-js-npm-mac) (Mac)
    - Or any other [package manager](https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager)
1. Clone the repo
1. Install dependencies (at the root of the repo):

    ```
    npm install
    ```

1. Run the project

    ```
    npm start
    ```

1. Build for deployment

    ```
    npm run build
    ```

1. Build for deployment (Windows only)

    ```
    npm run buildwin
    ```

Version Bump
-------------

- See [Bump a package version](https://docs.npmjs.com/cli/version)

Improve docs to explain how to use
Improve docs to explain how to use
