8000 Tweak the Readme of the example app · n00bdevel/example-ruby-app@ee12577 · GitHub
[go: up one dir, main page]
Skip to content

Commit ee12577

Browse files
dtKingerdtKinger
committed
Tweak the Readme of the example app
1 parent 5ee41a8 commit ee12577

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

‎README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# example-ruby-app
1+
# Example Shopify app in Ruby
22

3-
This is an example Shopify application written in Sinatra solely for the purposes of introducing new developers to the Shopify API.
3+
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.
4+
5+
## Credentials
46

57
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:
68
```
@@ -10,7 +12,9 @@ API_SECRET=YOUR_SECRET_KEY
1012

1113
where `YOUR_API_KEY` and `YOUR_SECRET_KEY` are the values of your application's API key and secret key respectively.
1214

13-
To get started with this example:
15+
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).
16+
17+
## Running the app
1418

1519
1. Create the `.env` file as described above.
1620
2. `bundle install` to obtain all of the necessary dependencies

0 commit comments

Comments
 (0)
0