Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updated README

  • Loading branch information...
commit dfec606f8ae71333f6bce095f70996131b7fb521 1 parent 877e568
@paddyforan paddyforan authored
Showing with 76 additions and 19 deletions.
  1. +76 −19 README.md
View
95 README.md
@@ -1,29 +1,86 @@
-# iron_rest_python
+# IronCache Python Client
-iron_rest_python is a collection of common functions for working with the RESTful APIs
-that we build at [Iron.io](http://www.iron.io) from Python.
+[IronCache](http://www.iron.io/products/cache) is a scalable, managed cache
+from [Iron.io](http://www.iron.io).
-## It Is
+## Getting Started
-* Service-agnostic
-* Pip- and easy_install-installable
-* Well documented
+### Get Credentials
-## It Is Not
+To use IronCache, you need to [sign up](https://hud.iron.io/users/new) and
+get your [OAuth token](https://hud.iron.io/tokens).
-* An API wrapper. Those are specific to each service, and you can generally find them
-by checking the documentation for the service.
-* A place for service-specific code. This is only meant to handle the basic, RESTful
-interaction.
+### Install iron_cache_python
-## Installation
+You can install iron_cache_python in two ways:
-You can use [pip](http://pip-installer.org) or [easy_install](http://wiki.python.org/moin/EasyInstall)
-to install the [release version](http://pypi.python.org/pypi/iron_rest_python). If you'd
-like to work with a development or beta version, retrieve the files [from Github](https://github.com/iron-io/iron_rest_python)
-and run `python setup.py install` from the root directory.
+#### pip/easy_install
+
+iron_cache_python is available in the Python Package Index as "iron_cache".
+This means you can run `pip install iron_cache` or `easy_install iron_cache`
+from your command line to download iron_cache_python and all its dependencies.
+
+#### From Source
+
+You can also [download the source](https://github.com/iron-io/iron_cache_python)
+from Github. Once you have the source, you can run `python setup.py install`
+from the directory containing the source code to install iron_cache_python.
+
+**Note**: You will need the [iron_core_python](https://github.com/iron-io/iron_core_python)
+module for iron_cache_python to function.
+
+### Configure Your Client
+
+iron_cache_python conforms to the [standard Iron.io configuration scheme](http://dev.iron.io/articles/configuration)
+that all official libraries use. This means your config files will work across
+languages and products.
+
+### Put Items In the Cache
+
+```python
+from iron_cache import *
+
+cache = IronCache()
+item = cache.put(cache="test_cache", key="mykey", value="Hello IronCache!")
+print item.value
+```
+
+### Get an Item In the Cache
+
+```python
+from iron_cache import *
+
+cache = IronCache()
+item = cache.get(cache="test_cache", key="mykey")
+print item.value
+```
+
+### Increment an Item's Value
+
+```python
+from iron_cache import *
+
+cache = IronCache()
+cache.increment(cache="test_cache", key="mykey", amount=10)
+```
+
+### Delete an Item From the Cache
+
+```python
+from iron_cache import *
+
+cache = IronCache()
+cache.delete(cache="test_cache", key="mykey")
+```
## License
-This software is released under the BSD 2-Clause License. You can find the full text of
-this license under LICENSE.txt in the module's root directory.
+This software is released under the BSD 2-Clause License. You can find the full
+text of this license under LICENSE.txt in the module's root directory.
+
+## More Documentation & Support
+
+More documentation can be found in the [Iron.io Dev Center](http://dev.iron.io).
+
+Iron.io offers a [public support chatroom](http://get.iron.io/chat) that is
+staffed by employees around the clock. We would be more than happy to assist you.
Please sign in to comment.
Something went wrong with that request. Please try again.