Skip to content
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

Merged
merged 1 commit into from
Jul 11, 2024
Merged

Clarify readme. #298

merged 1 commit into from
Jul 11, 2024

Conversation

Archmonger
Copy link
Owner

@Archmonger Archmonger commented Jul 10, 2024

Description

Checklist

Please update this checklist as you complete each item:

  • Tests have been developed for bug fixes or new functionality.
  • The changelog has been updated, if necessary.
  • Documentation has been updated, if necessary.
  • GitHub Issues closed by this PR have been linked.

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.

  • Documentation:
    • Updated the README to include a brief description of Conreq as a content requesting platform.
    • Removed detailed environment variable settings from the installation section in the README.
    • Simplified the installation instructions in the README to focus on Docker and Windows NSSM.

@Archmonger Archmonger marked this pull request as ready for review July 11, 2024 00:30
@Archmonger Archmonger merged commit 4802485 into main Jul 11, 2024
6 checks passed
Copy link

sourcery-ai bot commented Jul 11, 2024

Reviewer's Guide by Sourcery

This 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

Files Changes
README.md The README.md file was updated to include a brief description of Conreq, remove the specific date from the 'Notice' section, and simplify the 'Installation' section by removing detailed environment variables and focusing on Docker and Windows NSSM installation methods.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

@Archmonger Archmonger deleted the clarify-readme-0.21.1 branch July 11, 2024 00:30
Copy link

@sourcery-ai sourcery-ai bot left a 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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
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
Copy link

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/).
Copy link

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.

Suggested change
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/).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant