-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve readme instructions issue#35 #64
Conversation
Codecov Report
@@ Coverage Diff @@
## master #64 +/- ##
=======================================
Coverage 99.59% 99.59%
=======================================
Files 21 21
Lines 247 247
=======================================
Hits 246 246
Misses 1 1 Continue to review full report at Codecov.
|
We might need to update the Erlang version on Travis: We can define the version in our travis.yml file, see https://docs.travis-ci.com/user/languages/erlang/ However I don't think the error is directly linked to the Erlang version, I'll try to see what cause the exit status to 1: |
…p in docs!) for #35
…l/github-backup into improve-readme-instructions-issue#35
…l/github-backup into improve-readme-instructions-issue#35
@Cleop / @iteles / @SimonLab Thanks! ❤️ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple of small typos but otherwise it's looking 💯 🏅 , so much detail, nice one @nelsonic
.env_sample
Outdated
export SECRET_KEY_BASE=run:mix_phx.gen.secret-in-terminal-and-paste-result-here | ||
|
||
# AWS: | ||
export AWS_ACCESS_KEY_ID=aws-access-key |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tiny observation but perhaps aws-access-key
could say aws-access-key-id
in line with the key name?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for your attention to detail @Cleop 🎉
README.md
Outdated
|
||
The role of the Github application is to | ||
send **notifications** when **events** occur in your repositories. <br /> | ||
For example you can get be notified |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo, either needs to be 'For example you can get be notified' or 'For example you can get be notified'.
README.md
Outdated
``` | ||
- Define the local environment variables: | ||
Now that you have defined all the necessary | ||
environment variables in your `.env` file, <br / |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This <br /
is not closed, either close it or remove it 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎉 looks great, thanks @nelsonic for all the detailed steps
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! 🎉
new
"learn-ngrok" tutorial: https://github.com/dwyl/learn-ngrok.env_sample
file to speed up setup.see: Multi-line Environment Variables e.g: RSA Private Keys learn-environment-variables#17