README.md in linkedin_orbit-0.0.2 vs README.md in linkedin_orbit-0.1.0
- old
+ new
@@ -18,11 +18,11 @@
The application requires the following environment variables:
| Variable | Description | More Info
|---|---|--|
-| `LINKEDIN_CODE` | LinkedIn Browser Refresh Code | Follow the [First Time Setup guide](docs/FIRST_TIME_INSTRUCTIONS.md) to obtain the code
+| `LINKEDIN_TOKEN` | LinkedIn Token | Follow the [First Time Setup guide](docs/FIRST_TIME_INSTRUCTIONS.md) to obtain the token
| `LINKEDIN_ORGANIZATION` | LinkedIn Organization Page ID | Format: `urn:li:organization:#{id}`. ID is the set of numbers in LinkedIn page URL, i.e. `https://www.linkedin.com/company/28866695`, the ID is `28866695`.
| `ORBIT_API_KEY` | API key for Orbit | Found in `Account Settings` in your Orbit workspace
| `ORBIT_WORKSPACE_ID` | ID for your Orbit workspace | Last part of the Orbit workspace URL, i.e. `https://app.orbit.love/my-workspace`, the ID is `my-workspace`
## Package Usage
@@ -41,11 +41,11 @@
```ruby
client = LinkedinOrbit::Client.new(
orbit_api_key: YOUR_API_KEY,
orbit_workspace_id: YOUR_ORBIT_WORKSPACE_ID,
- linkedin_code: YOUR_LINKEDIN_BROWSER_REFRESH_CODE,
+ linkedin_token: YOUR_LINKEDIN_TOKEN,
linkedin_organization: YOUR_LINKEDIN_ORGANIZATION_ID
)
```
### Instantiation with credentials in dotenv file:
@@ -64,10 +64,10 @@
## CLI Usage
You can also use this package with the included CLI. To use the CLI pass in the required environment variables on the command line before invoking the CLI:
```bash
-$ ORBIT_API_KEY=... ORBIT_WORKSPACE_ID=... LINKEDIN_CODE=... LINKEDIN_ORGANIZATION=... bundle exec linkedin_orbit --check_comments
+$ ORBIT_API_KEY=... ORBIT_WORKSPACE_ID=... LINKEDIN_TOKEN=... LINKEDIN_ORGANIZATION=... bundle exec linkedin_orbit --check_comments
```
## GitHub Actions Automation Setup
⚡ You can set up this integration in a matter of minutes using our GitHub Actions template. It will run regularly to add new activities to your Orbit workspace. All you need is a GitHub account.