Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/bitdeli/bitdeli-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jyri Tuulos committed Jan 29, 2013
2 parents d0e0467 + c95a385 commit 17fdb17
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
1 change: 1 addition & 0 deletions build.sh
Expand Up @@ -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
10 changes: 4 additions & 6 deletions src/badge.rst
Expand Up @@ -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 <https://github.com/bitdeli/bitdeli-docs>`_.

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 <https://github.com/bitdeli/bitdeli-docs>`_.

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 <https://bitdeli.com/settings/data>`_. 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 <https://github.com/bitdeli/bd-ghbadge-visitors>`_). 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
------------------
Expand Down
1 change: 1 addition & 0 deletions src/datasources.rst
Expand Up @@ -14,6 +14,7 @@ and your current `Bitdeli plan </settings/billing>`_ 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
Expand Down
Binary file added src/images/trending_badge3.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 17fdb17

Please sign in to comment.