From ee12577864d1be9576fb7416a041d3044b27ea56 Mon Sep 17 00:00:00 2001 From: Dan King Date: Mon, 1 Feb 2016 16:19:01 -0500 Subject: [PATCH] Tweak the Readme of the example app --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1977e46..a557ef7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ -# example-ruby-app +# Example Shopify app in Ruby -This is an example Shopify application written in Sinatra solely for the purposes of introducing new developers to the Shopify API. +This is an example Shopify application written in [Sinatra](https://github.com/sinatra/sinatra) solely for the purposes of introducing new developers to the Shopify API. + +## Credentials This example uses a `.env` file to store the application credentials. After cloning the repository, you'll need to create a file named `.env` in the same folder. The contents of the file should be as follows: ``` @@ -10,7 +12,9 @@ API_SECRET=YOUR_SECRET_KEY where `YOUR_API_KEY` and `YOUR_SECRET_KEY` are the values of your application's API key and secret key respectively. -To get started with this example: +To retrieve your API credentials, sign up for a [Shopify Partners account](https://app.shopify.com/services/partners/auth/login) and [follow this guide](/api/introduction/getting-started). + +## Running the app 1. Create the `.env` file as described above. 2. `bundle install` to obtain all of the necessary dependencies