Skip to content

Commit 7da4d28

Browse files
committed
docs: Update Readme and Changelog
1 parent 5e9249b commit 7da4d28

File tree

2 files changed

+12
-52
lines changed

2 files changed

+12
-52
lines changed

CHANGELOG.md

Lines changed: 10 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -3,54 +3,16 @@
33
### 1.0.0
44
Complete rewrite in ES2015.
55

6-
* Renamed many of the APIs for better internal consistency.
76
* Promise-ified the API
8-
* Modularized code to potentially allow for custom builds
9-
* Refactored tests to run primarially in mocha
107
* Auto-generation of documentation
8+
* Modularized codebase
9+
* Refactored tests to run primarially in mocha
1110

12-
### 0.10.X
13-
14-
Create and delete repositories
15-
Repos - getCommit
16-
17-
### 0.9.X
18-
19-
Paging (introduced at tail end of 0.8.X, note: different callbacks for success & errors now)
20-
21-
### 0.8.X
22-
23-
Fixes and tweaks, simpler auth, CI tests, node.js support, Raw+JSON, UTF8, plus:
24-
Users - follow, unfollow, get info, notifications
25-
Gists - create
26-
Issues - get
27-
Repos - createRepo, deleteRepo, createBranch, star, unstar, isStarred, getCommits, listTags, listPulls, getPull, compare
28-
Hooks - listHooks, getHook, createHook, editHook, deleteHook
29-
30-
### 0.7.X
31-
32-
Switched to a native `request` implementation (thanks @mattpass). Adds support for GitHub gists, forks and pull requests.
33-
34-
### 0.6.X
35-
36-
Adds support for organizations and fixes an encoding issue.
37-
38-
### 0.5.X
39-
40-
Smart caching of latest commit sha.
41-
42-
### 0.4.X
43-
44-
Added support for [OAuth](http://developer.github.com/v3/oauth/).
45-
46-
### 0.3.X
47-
48-
Support for Moving and removing files.
49-
50-
### 0.2.X
51-
52-
Consider commit messages.
53-
54-
### 0.1.X
55-
56-
Initial version.
11+
#### Breaking changes
12+
* Search API no longer takes a string it now takes an object with properties `q`, `sort`, and `order` to make
13+
the parts of the query easier to grok and to better match GitHub's API
14+
* `Repository.getSha` now returns the same data as GitHub's API. If the reqeusted object is not a directory then the
15+
response will contain a property `SHA`, and if the reqeusted object is a directory then the contents of the
16+
directory are `stat`ed
17+
* `Repository.getRef` now returns the `refspec` from GitHub's API.
18+
* `Repository.delete` has been removed

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,11 @@ Github.js provides a minimal higher-level wrapper around Github's API. It was co
1010
[Prose][prose], a content editor for GitHub.
1111

1212
## Installation
13-
Github.js is available from `npm` or `bower`.
13+
Github.js is available from `npm` or (soon) [cdnjs][cdnjs].
1414

1515
```
1616
npm install github-api
1717
```
18-
```
19-
bower install github-api
20-
```
2118

2219
## Compatibility
2320

@@ -40,6 +37,7 @@ as well. In the meantime, we recommend you to take a look at other projects of t
4037

4138
**TODO**
4239

40+
[cdnjs]: https://cdnjs.com/
4341
[codecov]: https://codecov.io/github/michael/github?branch=master
4442
[travis-ci]: https://travis-ci.org/michael/github
4543
[gitter]: https://gitter.im/michael/github

0 commit comments

Comments
 (0)