diff options
author | Feross Aboukhadijeh <feross@feross.org> | 2016-03-17 00:56:31 +0300 |
---|---|---|
committer | Feross Aboukhadijeh <feross@feross.org> | 2016-03-17 00:56:31 +0300 |
commit | 086da7e382e71fe499945c05de4acff32f0528da (patch) | |
tree | 19d78010bda90c3420c1c3519ff49e99b3895617 | |
parent | f8267e7ddcf66da540d2012a4f0b28ccebaffa9a (diff) |
readme
-rw-r--r-- | README.md | 16 | ||||
-rw-r--r-- | docs/faq.md | 3 |
2 files changed, 9 insertions, 10 deletions
@@ -125,12 +125,16 @@ npm install webtorrent-cli -g - **Join us in [Gitter][webtorrent-gitter-url]** or on freenode at `#webtorrent` to help with development or to hang out with some mad science hackers :) - **[Create a new issue](https://github.com/feross/webtorrent/issues/new)** to report bugs -- **[Fix an issue](https://github.com/feross/webtorrent/issues?state=open)**. Note: - WebTorrent is an [OPEN Open Source Project](CONTRIBUTING.md)! +- **[Fix an issue](https://github.com/feross/webtorrent/issues?state=open)**. WebTorrent + is an [OPEN Open Source Project](CONTRIBUTING.md)! ### Who is using WebTorrent today? -See [full list of WebTorrent users](docs/faq.md#who-is-using-webtorrent-today). +[Lots of folks!](docs/faq.md#who-is-using-webtorrent-today) + +### WebTorrent API Documentation + +Read the [full API Documentation](docs/api.md). ### Usage @@ -175,7 +179,7 @@ dragDrop('body', function (files) { }) ``` -There are more examples in the [examples](https://github.com/feross/webtorrent/tree/master/examples) folder. +There are more examples in [docs/get-started.md](docs/get-started.md). ##### Browserify @@ -238,10 +242,6 @@ There are many supported streaming options: In addition to magnet uris, webtorrent supports [many ways to specify a torrent](#clientaddtorrentid-opts-function-ontorrent-torrent-). -### API - -See [docs/api.md](docs/api.md). - ### Modules Most of the active development is happening inside of small npm modules which are used by WebTorrent. diff --git a/docs/faq.md b/docs/faq.md index 55ccde2..aab0fcf 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -72,8 +72,7 @@ WebTorrent is still pretty new, but it's already being used in cool ways: - **[Niagara][niagara]** - Video player webtorrent with subtitles (zipped .srt(s)) - **[Vique][vique]** - Video player queue to share videos - **[YouShark][youshark]** - Web music player for WebTorrent ([source code][youshark-source]) - -- *Your app here – [Send a pull request][pr] with your URL!* +- ***Your app here – [Send a pull request][pr] with your URL!*** [webtorrent-app]: https://github.com/feross/webtorrent-app [instant.io-source]: https://github.com/feross/instant.io |