Skip to content
This repository has been archived by the owner on Aug 13, 2021. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mikermcneil committed Mar 3, 2013
1 parent d086fdb commit b8e921d
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,22 @@ A template for you to get started writing an official adapter for Sails.js.

## Getting started

1) Fork this repository
2) Build your adapter.
1. Fork this repository
2. Build your adapter.

## How to test your adapter

1) Run `npm link` in this adapter's directory
2) Clone the sails.js core and modify the tests to use your new adapter.
3) Run `npm link sails-boilerplate`
4) From the sails.js core directory, run `npm test`.
1. Run `npm link` in this adapter's directory
2. Clone the sails.js core and modify the tests to use your new adapter.
3. Run `npm link sails-boilerplate`
4. From the sails.js core directory, run `npm test`.

## Submitting your adapter
1) Do a pull request to this repository (make sure you attribute yourself as the author set the license in the package.json to "MIT") Please let us know about any special instructions for usage/testing.
2) We'll run the tests one last time. If there are any issues, we'll let you know.
3) When it's ready, we'll update the documentation with information about your new adapter
4) Then we'll tweet and post about it on our blog, adoring you with lavish praises.
5) Mike will send you jelly beans.
1. Do a pull request to this repository (make sure you attribute yourself as the author set the license in the package.json to "MIT") Please let us know about any special instructions for usage/testing.
2. We'll run the tests one last time. If there are any issues, we'll let you know.
3. When it's ready, we'll update the documentation with information about your new adapter
4. Then we'll tweet and post about it on our blog, adoring you with lavish praises.
5. Mike will send you jelly beans.


## About Sails.js
Expand All @@ -38,4 +38,4 @@ You can learn more about


## Writing your own adapters
It's easy to add your own adapters for integrating with proprietary systems or existing open APIs. For most things, it's as easy as `require('some-module')` and mapping the appropriate methods to match waterline semantics.
It's easy to add your own adapters for integrating with proprietary systems or existing open APIs. For most things, it's as easy as `require('some-module')` and mapping the appropriate methods to match waterline semantics.

0 comments on commit b8e921d

Please sign in to comment.