Skip to content
This repository was archived by the owner on Apr 2, 2024. It is now read-only.

Tweak the Readme of the example app #1

Merged
merged 1 commit into from
Feb 9, 2016
Merged

Tweak the Readme of the example app #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
```
Expand All @@ -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
Expand Down