-
-
Notifications
You must be signed in to change notification settings - Fork 10
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
Clarify readme. #298
Clarify readme. #298
Conversation
Reviewer's Guide by SourceryThis pull request updates the README.md file to provide a clearer and more concise overview of Conreq. It adds a brief description of the platform, removes the specific date from the 'Notice' section, and simplifies the 'Installation' section by removing detailed environment variables and focusing on Docker and Windows NSSM installation methods. File-Level Changes
Tips
|
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.
Hey @Archmonger - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 2 issues found
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
EMAIL_HOST_USER = [email protected] # default: None | ||
EMAIL_HOST_PASSWORD = dogmemes123 # default: None | ||
``` | ||
## Installation |
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.
question (documentation): Question removal of environment variables list.
The environment variables list is important for configuration. Is there a new location for this information or is it no longer relevant?
``` | ||
## Installation | ||
|
||
Install through [Docker](https://archmonger.github.io/Conreq/latest/install/docker/) or [Windows NSSM](https://archmonger.github.io/Conreq/latest/install/nssm/). |
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.
suggestion (documentation): Expand 'NSSM' for clarity.
Consider adding a brief explanation or a link to what NSSM stands for.
Install through [Docker](https://archmonger.github.io/Conreq/latest/install/docker/) or [Windows NSSM](https://archmonger.github.io/Conreq/latest/install/nssm/). | |
Install through [Docker](https://archmonger.github.io/Conreq/latest/install/docker/) or [Windows NSSM (Non-Sucking Service Manager)](https://archmonger.github.io/Conreq/latest/install/nssm/). |
Description
Checklist
Please update this checklist as you complete each item:
By submitting this pull request I agree that all contributions comply with this project's open source license(s).
Summary by Sourcery
This pull request updates the README to provide a clearer description of Conreq, simplifies the installation instructions, and removes detailed environment variable settings.