Skip to content

Clean and Verify README Accuracy#155

Merged
brennondenny merged 6 commits intoRelease2from
r2-feature-readme
May 19, 2018
Merged

Clean and Verify README Accuracy#155
brennondenny merged 6 commits intoRelease2from
r2-feature-readme

Conversation

@brennondenny
Copy link
Contributor

I've done my best to make the README much easier to follow and understand. For the reviews, read over the README and make sure you understand everything it's trying to convey.

readme.md Outdated
Create an ```.env``` file in the root directory with the following sensitive information. Replace the "xxx"'s with some unique information for your local Environment.

```
```json
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't json, should be Shell

@mpeck99
Copy link

mpeck99 commented May 18, 2018

So overall this looks good and it is definitely easier to read and understand. Have you though about putting in a section on what to do if your bot fails to load new changes. I know I have come across the issue beginning of the month and not knowing how to fully clear my old changes and loading the new with docker-compose down && docker-compose up --build

@mattpezzente
Copy link

I think Morgan pinned down exactly what I was going to mention. That is definitely a useful command, so nice work including it in there. I think the ReadMe looks much clearer to read overall, and looks good to merge live.

@brennondenny brennondenny merged commit f2cd159 into Release2 May 19, 2018
@reactivepixel reactivepixel deleted the r2-feature-readme branch August 21, 2019 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants