Skip to content

Commit 34b2711

Browse files
authored
Update README.md
1 parent d8a9bf0 commit 34b2711

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,15 @@ It provides the necessary to communicate with the Pub/Sub Salesforce API (Change
88

99
This section provides the necessary instructions to run the project as well as subscribe to a topic
1010

11-
The custom object that we are going to listen is already set and created.
11+
The custom object that we are going to listen should already be set and created in SF.
1212

13-
You should perform actions like: create, edit, etc... through [UI Custom Object in SF](https://renofi--stag.sandbox.lightning.force.com/lightning/o/Game__c/home) - login with staging 1pass credentials
13+
You should perform actions like: create, edit, etc... through this created Custom Object in SF's UI
1414

1515
**Commands**
1616

17-
1. `bundle install`
18-
2. `bin/console`
17+
1. cd to the cloned repo
18+
2. `bundle install`
19+
3. `bin/console`
1920

2021
```console
2122
irb:001 > example = Example::App.new
@@ -26,6 +27,8 @@ Subscribed to .... (topic name)
2627
# events will appear here as soon as you perform any operations on the UI
2728
```
2829

30+
**Don't forget to add your own configurations in a new `.env.local` file. It's required to have it set with your SF configs/credentials**
31+
2932
## Useful documentation
3033
1. [Change Data Capture docs](https://trailhead.salesforce.com/content/learn/modules/change-data-capture)
3134
2. [How to create a subscription](https://trailhead.salesforce.com/content/learn/modules/change-data-capture/subscribe-to-events#subscribe-using-pub-sub-api)

0 commit comments

Comments
 (0)