# Flow XO <%= name %> Service

This is a <%= name %> service module for the [Flow XO](https://flowxo.com) platform. For more details on how to develop and test this service, please refer to the [Flow XO SDK](http://github.com/flowxo/flowxo-sdk).

## Contributing

``` bash
# Clone the repo
git clone https://bitbucket.org/flowxo/<%= serviceName %>

# Install the dependencies
npm install -g yo grunt-cli
npm install

# Generate a new method
yo flowxo:method

# Watch files for changes, running style checks and unit tests on change
grunt

# Run unit tests
grunt test

# Create/renew an authentication file
grunt auth

# Run integration tests, using authentication
grunt run [--record --replay --name=<name>]

```

# Flow XO <%= name %> Service

This is a <%= name %> service module for the [Flow XO](https://flowxo.com) platform. For more details on how to develop and test this service, please refer to the [Flow XO SDK](http://github.com/flowxo/flowxo-sdk).

## Usage

Steps to run the service from the command line using the Flow XO SDK
``` bash
# Clone the repo
git clone https://github.com/flowxo/<%= serviceName %>
cd <%= serviceName %>

# Install the dependencies
npm install
grunt init

<% if(auth.type.indexOf('oauth') === 0) { %>
# Create a .env file with the following content (no hashes):
<% if(auth.type.indexOf('oauth')===0) { %><%= slugUpperCased %><% if(auth.type === 'oauth1') { %>_KEY=<YOUR_APP_KEY><% } else { %>_ID=<YOUR_APP_ID><% } %>
<%= slugUpperCased %>_SECRET=<YOUR_APP_SECRET><% } %><% } %>

# Create an authentication
grunt auth

# Run methods
grunt run
```

## Contributing

``` bash
# Clone the repo
git clone https://github.com/flowxo/<%= serviceName %>

# Install the dependencies
npm install -g yo grunt-cli
npm install
grunt init

# Generate a new method
yo flowxo:method

# Watch files for changes, running style checks and unit tests on change
grunt

# Run unit tests
grunt test

# Create/renew an authentication file
grunt auth

# Run integration tests, using authentication
grunt run [--record --replay --name=<name>]

```

Add Usage section to readme and change link from bitbucket to github
Add Usage section to readme and change link from bitbucket to github
