diff --git a/README.md b/README.md index 5e5f527f..9b8d6062 100644 --- a/README.md +++ b/README.md @@ -1,126 +1,3 @@ -# Maintainers wanted -[Apply within](https://github.com/github-tools/github/issues/539) - -# Github.js - -[![Downloads per month](https://img.shields.io/npm/dm/github-api.svg?maxAge=2592000)][npm-package] -[![Latest version](https://img.shields.io/npm/v/github-api.svg?maxAge=3600)][npm-package] -[![Gitter](https://img.shields.io/gitter/room/github-tools/github.js.svg?maxAge=2592000)][gitter] -[![Travis](https://img.shields.io/travis/github-tools/github.svg?maxAge=60)][travis-ci] -[![Codecov](https://img.shields.io/codecov/c/github/github-tools/github.svg?maxAge=2592000)][codecov] - -`Github.js` provides a minimal higher-level wrapper around Github's API. - -## Usage - -```javascript -/* - Data can be retrieved from the API either using callbacks (as in versions < 1.0) - or using a new promise-based API. The promise-based API returns the raw Axios - request promise. - */ -import GitHub from 'github-api'; - -// unauthenticated client -const gh = new GitHub(); -let gist = gh.getGist(); // not a gist yet -gist.create({ - public: true, - description: 'My first gist', - files: { - "file1.txt": { - content: "Aren't gists great!" - } - } -}).then(function({data}) { - // Promises! - let createdGist = data; - return gist.read(); -}).then(function({data}) { - let retrievedGist = data; - // do interesting things -}); -``` - -```javascript -var GitHub = require('github-api'); - -// basic auth -var gh = new GitHub({ - username: 'FOO', - password: 'NotFoo' - /* also acceptable: - token: 'MY_OAUTH_TOKEN' - */ -}); - -var me = gh.getUser(); // no user specified defaults to the user for whom credentials were provided -me.listNotifications(function(err, notifications) { - // do some stuff -}); - -var clayreimann = gh.getUser('clayreimann'); -clayreimann.listStarredRepos(function(err, repos) { - // look at all the starred repos! -}); -``` - -## API Documentation - -[API documentation][docs] is hosted on github pages, and is generated from JSDoc; any contributions -should include updated JSDoc. - -## Installation -`Github.js` is available from `npm` or [unpkg][unpkg]. - -```shell -npm install github-api -``` - -```html - - - - - -``` - -## Compatibility -`Github.js` is tested on node's LTS and current versions. - -[codecov]: https://codecov.io/github/github-tools/github?branch=master -[docs]: http://github-tools.github.io/github/ -[gitter]: https://gitter.im/github-tools/github -[npm-package]: https://www.npmjs.com/package/github-api/ -[unpkg]: https://unpkg.com/github-api/ -[travis-ci]: https://travis-ci.org/github-tools/github - -## Contributing - -We welcome contributions of all types! This section will guide you through setting up your development environment. - -### Setup - -1. [Install Node](https://nodejs.org/en/) version 8,10 or 11. It can often help to use a Node version switcher such as [NVM](https://github.com/nvm-sh/nvm). -2. Fork this repo to your GitHub account. -3. Clone the fork to your development machine (`git clone https://github.com/{YOUR_USERNAME}/github`). -4. From the root of the cloned repo, run `npm install`. -5. Email jaredrewerts@gmail.com with the subject **GitHub API - Personal Access Token Request** - -A personal access token for our test user, @github-tools-test, will be generated for you. - -6. Set the environment variable `GHTOOLS_USER` to `github-tools-test`. - -`export GHTOOLS_USER=github-tools-test` - -7. Set the environment variable `GHTOOLS_PASSWORD` to the personal access token that was generated for you. - -`export GHTOOLS_PASSWORD={YOUR_PAT}` - -**NOTE** Windows users can use [this guide](http://www.dowdandassociates.com/blog/content/howto-set-an-environment-variable-in-windows-command-line-and-registry/) to learn about setting environment variables on Windows. - -### Tests - -The main way we write code for `github-api` is using test-driven development. We use Mocha to run our tests. Given that the bulk of this library is just interacting with GitHub's API, nearly all of our tests are integration tests. - -To run the test suite, run `npm run test`. +# this is heading 1 in md +## this is heading 2 in md +### this is heading 3 in md