Twit-arr Client API
A client API for interacting with the Twit-arr social networking platform.
Using the Twitarr.js APIs In Your Code
(Coming soon.)
API Coverage
Twitarr.js currently supports a subset of the Twit-arr ReST API:
- retrieve profile information
- list, read, and post seamail messages
- read and post tweets
The intention is to implement 100% of the features specified in the Twit-arr ReST documentation.
Changes
The CHANGELOG will be updated as releases occur, and should always be accessible here.
Development
To build this project, run npm install
to install all dependencies.
Then you can run npm to build or test the project:
npm run dist
- run tests and lint, and build the complete tree indist/
npm run dev
- build a development version of the API indist/twitarr.js
anddist/twitarr.node.js
npm run build
- build the development and production versions of the API indist/
npm run docs
- build the docs indist/docs/
npm run watch
- continuously build the development version indist/twitarr.js
npm run test
- run the testsnpm run watch-test
- continuously run the testsnpm run cli -- <arguments>
- run the CLI test tool (try--help
for options)npm run release
- do a release build, regeneratingdist/
, and updating the changelog.
Reporting Bugs or Feature Requests
Twitarr.js issues are tracked in the Twit-arr issue tracker: https://github.com/RangerRick/twitarr-client-api/issues