Skip to content

Commit

Permalink
Merge pull request #163 from scrapinghub/mention-binaries-in-readme
Browse files Browse the repository at this point in the history
Mention binaries and multiple API keys in README
  • Loading branch information
jdemaeyer committed Feb 16, 2016
2 parents 08e53a6 + 0e72f68 commit 70601f7
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,16 @@ Requirements
Installation
------------

Install with::
If you have ``pip`` installed on your system, you can install ``shub`` from
the Python Package Index::

pip install shub

We also supply stand-alone binaries. You can find them in our `latest GitHub
release`_.

.. _`latest Github release`: https://github.com/scrapinghub/shub/releases/latest


Usage
-----
Expand Down Expand Up @@ -252,16 +258,26 @@ option to receive live updates::

.. END_SH_DOC
API Endpoints (for Scrapinghub staff only)
------------------------------------------
Advanced use cases
------------------

It is possible to configure multiple API keys::

It is possible to configure different API endpoints::
# scrapinghub.yml
projects:
default: 123
otheruser: someoneelse/123
apikeys:
default: 0bbf4f0f691e0d9378ae00ca7bcf7f0c
someoneelse: a1aeecc4cd52744730b1ea6cd3e8412a

# ~/.scrapinghub.yml
as well as different API endpoints::

# scrapinghub.yml
projects:
dev: vagrant/3
endpoints:
vagrant: http://vagrant:3333/api/
apikeys: # populated manually or via shub login
apikeys:
default: 0bbf4f0f691e0d9378ae00ca7bcf7f0c
vagrant: a1aeecc4cd52744730b1ea6cd3e8412a

0 comments on commit 70601f7

Please sign in to comment.