Add to do and additional cache types.

Author: danielecook

DESCRIPTION

@@ -1,5 +1,5 @@
 Encoding: UTF-8
-Package: memoise2
+Package: xmemoise
 Title: Memoisation of Functions
 Version: 1.0.0.9000
 Authors@R: c(

README.md

@@ -1,10 +1,19 @@
-# memoise [![Travis-CI Build Status](https://travis-ci.org/hadley/memoise.svg?branch=master)](https://travis-ci.org/hadley/memoise) [![Coverage Status](https://img.shields.io/codecov/c/github/hadley/memoise/master.svg)](https://codecov.io/github/hadley/memoise?branch=master)
+# xmemoise 
 
+Forked from [hadley/memoise](https://github.com/hadley/memoise)
+
+# Installation
+
+```
+devtools::install_github("danielecook/xmemoise")
+```
+
+# Memoization
 
 If a function is called multiple times with the same input, you can
 often speed things up by keeping a cache of known answers that it can
 retrieve. This is called memoisation <http://en.wikipedia.org/wiki/Memoization>.
-The `memoise` package provides a simple syntax 
+The `xmemoise` package is built upon [hadley/memoise](https://github.com/hadley/memoise), which provides a simple syntax 
 
     mf <- memoise(f)
 
@@ -18,4 +27,27 @@ cache with
     is.memoised(mf) # TRUE
     is.memoised(f)  # FALSE
 
-.
+
+`xmemoise` extends upon `memoise` by adding in additional types of caches. Items can be cached using the original cache implemented in `memoise` in addition to other options:
+
+* [x] Google Datastore; Switch to using googleAuthR
+* [ ] Dropbox
+* [ ] Google Storage
+* [ ] AWS
+
+
+# Memoization with google datastore
+
+Google Datastore 
+
+There are a few trade-offs to using google datastore for memoization.
+
+```
+key <- "<google cloud oauth key>"
+secret <- "<google cloud oauth secret>"
+authenticate_datastore(key, secret, "<project-id>")
+
+mem_fib <- memoise(fib, cache = datastore_cache("custom_cache_name"))
+mem_fib(20) # Saved to datastore; Can be retrieved on another computer.
+mem_fib(20) # Cached version retrieved from google datastore.
+```