diff --git a/build.sh b/build.sh index 1f15e01..aeea783 100755 --- a/build.sh +++ b/build.sh @@ -19,5 +19,6 @@ getgit "profile-toy-data" getgit "profile-github-commits" getgit "profile-ghbadge" getgit "profile-events-raw" +getgit "profile-jsapi" sphinx-build src html diff --git a/src/badge.rst b/src/badge.rst index 4d7b32c..30067b1 100644 --- a/src/badge.rst +++ b/src/badge.rst @@ -4,20 +4,18 @@ Bitdeli Badge for GitHub ======================== -.. image:: images/free_landing_badge@2X.png - :scale: 40% +.. image:: images/trending_badge3.png :align: center +You can get started with Bitdeli for free by adding the Bitdeli badge to the readme file of at least one of your GitHub repositories. For instance, you can see `the badge live in this repository `_. -You can get started with Bitdeli for free by adding our badge to the readme file of at least one of your GitHub repositories. For instance, you can see `a badge live in this repository `_. - -The badge serves two purposes: Firstly, the badge itself shows when the repository starts growing more popular, as described in the next section. Secondly, every time someone views the repository the badge is loaded from the lightning fast Amazon Content Distribution Network, which produces an event in the access log. +Every time someone views the repository the badge is loaded from the lightning fast Amazon Content Distribution Network, which produces an event in the access log. This benefits you in two ways: First, the badge itself shows when the repository starts growing more popular, as described in the next section. Second, you can analyze the events by yourself in Bitdeli. You can access the raw events by creating a free Bitdeli account at https://bitdeli.com/free after you have added the badge. Alternatively, you can connect a *GitHub Badge* data source in `your account settings `_. It may take up to an hour for the events to appear after you have added a badge for the first time. We add a card showing basic stats about your visitors after you have signed up (see `its source code here `_). Once the data starts flowing in, you can see the requests under the *Profiles* tab in the :ref:`editor`. For a detailed description of the data format, see :ref:`data-sources`. Note that the data source includes data from all badges under your GitHub account, so you can easily compare performance of different repositories. -Let your imagination free and start hacking your own GitHub analytics! Once you are done, be sure to share the results on GitHub using our :ref:`githubb`. +Set your imagination free and start hacking your own GitHub analytics! Once you are done, be sure to share the results on GitHub using our :ref:`githubb`. Trending algorithm ------------------ diff --git a/src/datasources.rst b/src/datasources.rst index ec3ea39..0f8bb5c 100644 --- a/src/datasources.rst +++ b/src/datasources.rst @@ -14,6 +14,7 @@ and your current `Bitdeli plan `_ that affects how much histo The currently available data sources are documented below. +.. include:: ../repos/profile-jsapi/README.rst .. include:: ../repos/profile-events-raw/README.rst .. include:: ../repos/profile-mixpanel-hourly/README.rst .. include:: ../repos/profile-ghbadge/README.rst diff --git a/src/images/trending_badge3.png b/src/images/trending_badge3.png new file mode 100644 index 0000000..3bd0731 Binary files /dev/null and b/src/images/trending_badge3.png differ