Skip to content

Commit

Permalink
Fix #89 - Made README more user friendly.
Browse files Browse the repository at this point in the history
Focusing more on *users* of the library than *developers* of the library.
  • Loading branch information
jgeewax committed May 2, 2014
1 parent fbdff58 commit f32f10e
Showing 1 changed file with 41 additions and 16 deletions.
57 changes: 41 additions & 16 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,28 +1,33 @@
Google Cloud
============
Google Cloud Python Client
==========================

Official documentation
----------------------
The goal of this project is to make it really simple and Pythonic
to use Google Cloud Platform services.

If you just want to **use** the library
(not contribute to it),
check out the official documentation:
http://GoogleCloudPlatform.github.io/gcloud-python/
Quickstart
----------

Incredibly quick demo
---------------------
The library is ``pip``-installable::

Start by cloning the repository::
$ pip install gcloud
$ python -m gcloud.storage.demo # Runs the storage demo!

$ git clone git://github.com/GoogleCloudPlatform/gcloud-python.git
$ cd gcloud
$ python setup.py develop
Documentation
-------------

- `gcloud docs (browse all services, quick-starts, walk-throughs) <http://GoogleCloudPlatform.github.io/gcloud-python/>`_
- `gcloud.datastore API docs <http://googlecloudplatform.github.io/gcloud-python/datastore-api.html>`_
- `gcloud.storage API docs <http://googlecloudplatform.github.io/gcloud-python/storage-api.html>`_
- gcloud.bigquery API docs (*coming soon)*
- gcloud.compute API docs *(coming soon)*
- gcloud.dns API docs *(coming soon)*
- gcloud.sql API docs *(coming soon)*

I'm getting weird errors... Can you help?
-----------------------------------------

Chances are you have some dependency problems,
if you're on Ubuntu,
Chances are you have some dependency problems...
If you're on Ubuntu,
try installing the pre-compiled packages::

$ sudo apt-get install python-crypto python-openssl libffi-dev
Expand All @@ -32,6 +37,7 @@ or try installing the development packages
and then ``pip install`` the dependencies again::

$ sudo apt-get install python-dev libssl-dev libffi-dev
$ pip install gcloud

How do I build the docs?
------------------------
Expand All @@ -50,4 +56,23 @@ Make sure you have ``nose`` installed and::

$ git clone git://github.com/GoogleCloudPlatform/gcloud-python.git
$ pip install unittest2 nose
$ cd gcloud-python
$ nosetests

How can I contribute?
---------------------

Before we can accept any pull requests
we have to jump through a couple of legal hurdles,
primarily a Contributor License Agreement (CLA):

- **If you are an individual writing original source code**
and you're sure you own the intellectual property,
then you'll need to sign an `individual CLA
<http://code.google.com/legal/individual-cla-v1.0.html>`_.
- **If you work for a company that wants to allow you to contribute your work**,
then you'll need to sign a `corporate CLA
<http://code.google.com/legal/corporate-cla-v1.0.html>`_.

You can sign these electronically (just scroll to the bottom).
After that, we'll be able to accept your pull requests.

0 comments on commit f32f10e

Please sign in to comment.