You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
52 lines
2.4 KiB
52 lines
2.4 KiB
# twilio-node
|
|
|
|
A node.js Twilio helper library.
|
|
|
|
[](https://nodei.co/npm/twilio/)
|
|
|
|
[](https://travis-ci.org/twilio/twilio-node)
|
|
|
|
## End User Docs
|
|
|
|
For detailed usage information and API docs, head out here:
|
|
|
|
[http://twilio.github.io/twilio-node/](http://twilio.github.io/twilio-node/)
|
|
|
|
## Getting help
|
|
|
|
If you need help installing or using the library, please contact Twilio Support at help@twilio.com first. Twilio's Support staff are well-versed in all of the Twilio Helper Libraries, and usually reply within 24 hours.
|
|
|
|
If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!
|
|
|
|
## Contributing
|
|
|
|
Bug fixes, docs, and enhancements welcome! If you're not familiar with the GitHub pull request/contribution process, [this is a nice tutorial](http://gun.io/blog/how-to-github-fork-branch-and-pull-request/).
|
|
|
|
#### Getting Started
|
|
Fork and clone the repository. Install dependencies with:
|
|
|
|
npm install
|
|
|
|
Run the existing test spec with `npm test`.
|
|
|
|
To run just one specific test file instead of the whole suite, provide a JavaScript regular expression that will match your spec file's name, like:
|
|
|
|
./node_modules/.bin/jasmine-node spec -m .\*accounts.\*
|
|
|
|
To run live tests (such as `client.live.spec.js`) against your [Twilio account](https://www.twilio.com/user/account), you will need to create a local configuration file. In the project root directory, do the following:
|
|
|
|
* `cp config.sample.js config.js`
|
|
* Edit `config.js` with your account information, a Twilio number, and your own mobile number
|
|
* Run the live tests
|
|
|
|
#### Contributing Code
|
|
|
|
In your fork, create a new feature/bug fix branch, [per the guide listed above](http://gun.io/blog/how-to-github-fork-branch-and-pull-request/). Write a Jasmine test spec for your new feature or bug fix, and hack until it passes! Submit a pull request, and it will be reviewed as soon as possible.
|
|
|
|
#### Contributing Docs
|
|
|
|
Right now, the docs are maintained in static HTML in the `gh-pages` branch of this repository. We hope to switch to a more robust documentation system soon, but for the time being, you can make documentation changes by editing [index.html](https://github.com/twilio/twilio-node/blob/gh-pages/index.html) directly.
|
|
|
|
|
|
|