Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pomber committed Mar 19, 2019
1 parent 2fe8d26 commit fb5e5f4
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 21 deletions.
6 changes: 6 additions & 0 deletions .github/opencollective.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
collective: git-history
tiers:
- tiers: "*"
labels: ["backer"]
- tiers: ["sponsor", "super sponsor"]
labels: ["sponsor"]
33 changes: 12 additions & 21 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
<div align="center">
<a href="https://github.githistory.xyz/babel/babel/blob/master/packages/babel-core/test/browserify.js">
<img alt="demo" src="https://user-images.githubusercontent.com/1911623/52460615-f3899d80-2b49-11e9-8c21-06af4097a527.gif" />
<a href="https://github.githistory.xyz/torvalds/linux/blob/master/kernel/up.c">
<img alt="demo" src="https://user-images.githubusercontent.com/1911623/54575634-9b10b000-49d3-11e9-8a19-56e40636e45d.gif" width="600" />
</a>
</div>

# [Git History](https://githistory.xyz)

Quickly browse the history of any GitHub ([GitLab and Bitbucket
coming soon](https://github.com/pomber/git-history/issues/14)) file:
Quickly browse the history of files in any git repo:

1. Replace `github.com` with `github.githistory.xyz` in any file url
2. There's no step two
1. Go to a file in **GitHub** (or **GitLab**, or **Bitbucket**)
1. Replace `github.com` with `github.githistory.xyz`
1. There's no step three

[Try it](https://github.githistory.xyz/babel/babel/blob/master/packages/babel-core/test/browserify.js)

> If you like this project consider [backing my open source work on Patreon!](https://patreon.com/pomber)
> And follow [@pomber](https://twitter.com/pomber) on twitter for updates.
## Browser Extensions
## Extensions

### Browsers

You can also add an `Open in Git History` button to GitHub, GitLab and Bitbucket with the [Chrome](https://chrome.google.com/webstore/detail/github-history-browser-ex/laghnmifffncfonaoffcndocllegejnf) and [Firefox](https://addons.mozilla.org/firefox/addon/github-history/) extensions.

Expand All @@ -38,22 +40,11 @@ javascript: (function() {

</details>

## [CLI](https://github.com/pomber/git-history/tree/master/cli)

There's also a command line version of Git History that works with any local git repo:

> You need [node](https://nodejs.org/en/) to run this
### Local Repos

```bash
$ npx git-file-history path/to/file.ext
```

or
You can use Git History for local git repos with the [CLI](https://github.com/pomber/git-history/tree/master/cli) or with the [VS Code extension](https://marketplace.visualstudio.com/items?itemName=pomber.git-file-history).

```bash
$ npm install -g git-file-history
$ git-file-history path/to/file.ext
```
## Support Git History

### Sponsors

Expand Down

0 comments on commit fb5e5f4

Please sign in to comment.