From 87ea2501b4d9fc6830fa1f57767a7525f228e40b Mon Sep 17 00:00:00 2001 From: Arnaud Ysmal Date: Wed, 19 Feb 2014 23:16:26 +0100 Subject: [PATCH] Update README.md --- README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/README.md b/README.md index d723814..6d87950 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,62 @@ dropbox ======= Go client library for the Dropbox core API with support for uploading and downloading encrypted files. + + +Prerequisite +------------ + +To use this library, you must have a valid client ID (app key) and client secret (app secret) provided by Dropbox. +To register a new client application, please visit https://www.dropbox.com/developers/apps/create + +Examples +-------- + +This simple 4-step example will show you how to create a folder: + + package main + + import ( + "dropbox" + "fmt" + ) + + func main() { + var err error + var db *dropbox.Dropbox + + var clientid, clientsecret string + var token string + + clientid = "xxxxx" + clientsecret = "yyyyy" + token = "zzzz" + + // 1. Create a new dropbox object. + db = dropbox.NewDropbox() + + // 2. Provide your clientid and clientsecret (see prerequisite). + db.SetAppInfo(clientid, clientsecret) + + // 3. Provide the user token. + db.SetAccessToken(token) + + // 4. Send your commands. + // In this example, you will create a new folder named "demo". + folder := "demo" + if _, err = db.CreateFolder(folder); err != nil { + fmt.Printf("Error creating folder %s: %s\n", folder, err) + } else { + fmt.Printf("Folder %s successfully created\n", folder) + } + } + +If you do not know the user token, you can replace step 3 by a call to the Auth method: + + // This method will ask the user to visit an URL and paste the generated code. + if err = db.Auth(); err != nil { + fmt.Println(err) + return + } + // You can now retrieve the token if you want. + token = db.AccessToken()