docs: update README

adds instructions for how bundle install the sftp gem
mlibrary · Jun 16, 2022 · db9e904 · db9e904
1 parent 3508a71
commit db9e904
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/.env-example b/.env-example
@@ -0,0 +1 @@
+BUNDLE_RUBYGEMS__PKG__GITHUB__COM="Your Github Personal Access Token with read:packages access"
diff --git a/README.md b/README.md
@@ -16,6 +16,13 @@ build web container
 docker-compose build web
 ```
 
+set up your .env file
+```
+cp .env-example .env
+```
+
+Replace the value for `BUNDLE_RUBYGEMS__PKG__GITHUB__COM` in the `.env` file with your [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) that has `read:packages` access. 
+
 bundle install gems to a docker volume
 ```
 docker-compose run --rm web bundle install
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		BUNDLE_RUBYGEMS__PKG__GITHUB__COM="Your Github Personal Access Token with read:packages access"