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.

Sign up for GitHub

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

Jump to bottom

Increased clarity of readme file #3

Open
rfuehrer opened this issue May 9, 2020 · 2 comments
Open

Increased clarity of readme file #3

rfuehrer opened this issue May 9, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@rfuehrer
Copy link
Member

rfuehrer commented May 9, 2020

The readme must be divided into different files in order to increase the readability and acceptance of the reader. For example, the installation or test notes can be offloaded to separate files. The readme then lists sections that indicate the separate files. These files can be stored in the /docs directory.
@rfuehrer rfuehrer added the documentation Improvements or additions to documentation label May 9, 2020
@rfuehrer
Copy link
Member Author

rfuehrer commented May 9, 2020

possible seperations are:

  • architecture
  • installation
  • test
  • deployment
  • expandability

@rfuehrer
Copy link
Member Author

rfuehrer commented May 10, 2020 •
edited
Loading

Further note: at the latest in this process also correct the title according to the repo name "Github Webhooks Framework"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Milestone
No milestone
Development

No branches or pull requests
1 participant
@rfuehrer