Permalink
Browse files

Update README and index.

  • Loading branch information...
1 parent 363df91 commit 6498363392bdb18d3e09b99523d1989cae41a837 @sigmavirus24 committed Oct 7, 2012
Showing with 14 additions and 7 deletions.
  1. +10 −5 README.rst
  2. +4 −2 subscribed/templates/index.html
View
@@ -1,9 +1,14 @@
-view_watchers
-=============
+subscribed
+==========
-This is just a small flask app using github3.py_ to display the people
-watching repositories. This information isn't available to everyone via the
-GitHub website, but it is available via the API.
+This is just a small flask app using github3.py_ to display which users are
+subscribed to which repositories. It can be used using endpoints like:
+
+- ``/login``, e.g., ``/sigmavirus24``
+- ``/login/repo``, e.g., ``/sigmavirus24/subscribed``
+
+This information isn't available to everyone via the GitHub website, but it is
+available via the API.
.. links
@@ -20,7 +20,9 @@
repositories (or anyone's repositories) without accessing the API. This
website makes that information freely available to you using <a
href="http://flask.pocoo.org">Flask</a> and
-<a href="https://github.com/sigmavirus24/github3.py">github3.py</a>.
-Simply use a link like <a href="/sigmavirus24/github3.py">this</a> and a
+<a href="https://github.com/sigmavirus24/github3.py">github3.py</a> and a
minimalistic design.
+Simply use a link like <a href="/sigmavirus24/github3.py">this</a> to find the
+subscribers to a repository. Use a link like <a href="/sigmavirus24">this</a>
+to find out what repositories a user is subscribed to.
{% endblock %}

0 comments on commit 6498363

Please sign in to comment.