Update README

Direct, TODOs, ng-file-upload, ui-grid, thanks
This commit is contained in:
Diego Rodríguez B 2015-12-06 23:41:30 -05:00
parent 7c2e573b22
commit 9cc38d0d9a

View file

@ -4,12 +4,17 @@
**[βTorrent]** is a fully-featured **[WebTorrent]** browser client written in [Jade], [CoffeeScript] and [Sass] **[βTorrent]** is a fully-featured **[WebTorrent]** browser client written in [Jade], [CoffeeScript] and [Sass]
### Features ### Features
- Informative GUI with easy sharing options - [x] Informative GUI with easy sharing options
- Downloading from an info hash or magnet URI - [x] Downloading from an info hash or magnet URI
- Seeding files (Single file only for the moment) - [ ] Downloading from a .torrent file (Coming Soon)
- Download/Upload speed per torrent - [x] Seeding files (Single file only for the moment)
- Removing torrents from the client - [ ] Seeding CORS-enabled remote files (Coming Soon)
- Client Debugging - [x] Download/Upload speed per torrent
- [ ] Download/Upload speed of client (All torrents)
- [ ] Removing torrents from the client (Coming Soon)
- [ ] Pause torrent (Coming Soon)
- [ ] Selecting/Deselecting files (Coming Soon)
- [x] Client Debugging
### Built with ### Built with
- [WebTorrent] - [WebTorrent]
@ -17,10 +22,14 @@
- [Skeleton] - [Skeleton]
- [Normalize.css] - [Normalize.css]
- [Moment.js] - [Moment.js]
- [ui-grid]
- [pretty-bytes] - [pretty-bytes]
- [ng-file-upload]
Website powered by [jsDelivr] and [CloudFlare]. I use [nginx] in my server. Website powered by [jsDelivr] and [CloudFlare]. I use [nginx] in my server.
Don't like CloudFlare? No problem! Check [Direct-βTorrent]
### Easily built, tested and served ### Easily built, tested and served
**I use [Harp] to rapidly test and compile the project** **I use [Harp] to rapidly test and compile the project**
@ -49,16 +58,23 @@ localStorage.removeItem('debug')
- **[Create a new issue](https://github.com/DiegoRBaquero/bTorrent/issues/new)** to report bugs or suggest new features - **[Create a new issue](https://github.com/DiegoRBaquero/bTorrent/issues/new)** to report bugs or suggest new features
- **[Send a PR](https://github.com/DiegoRBaquero/BTorrent/pull/new/master)** with your changes - **[Send a PR](https://github.com/DiegoRBaquero/BTorrent/pull/new/master)** with your changes
### Thanks
- [jasalo](https://github.com/jasalo) For the logo and favicon
- [whitef0x0](https://github.com/whitef0x0) For cleanup and ng-file-upload and other ideas
### License ### License
MIT. Copyright (c) [Diego Rodríguez Baquero](http://diegorbaquero.com) MIT. Copyright (c) [Diego Rodríguez Baquero](http://diegorbaquero.com)
[βTorrent]: https://btorrent.xyz [βTorrent]: https://btorrent.xyz
[Direct-βTorrent]: https://direct.btorrent.xyz
[WebTorrent]: https://webtorrent.io [WebTorrent]: https://webtorrent.io
[AngularJS]: https://angularjs.org/ [AngularJS]: https://angularjs.org/
[Skeleton]: http://getskeleton.com/ [Skeleton]: http://getskeleton.com/
[Normalize.css]: https://necolas.github.io/normalize.css/ [Normalize.css]: https://necolas.github.io/normalize.css/
[Moment.js]: http://momentjs.com/ [Moment.js]: http://momentjs.com/
[ui-grid]: http://ui-grid.info/
[pretty-bytes]: https://github.com/sindresorhus/pretty-bytes [pretty-bytes]: https://github.com/sindresorhus/pretty-bytes
[ng-file-upload]: https://github.com/danialfarid/ng-file-upload
[Jade]: http://jade-lang.com/ [Jade]: http://jade-lang.com/
[CoffeeScript]: http://coffeescript.org/ [CoffeeScript]: http://coffeescript.org/
[Sass]: http://sass-lang.com/ [Sass]: http://sass-lang.com/