Skip to content
This repository has been archived by the owner on May 25, 2024. It is now read-only.

docs: write a README #13

Open
KnorpelSenf opened this issue Jun 11, 2023 · 6 comments
Open

docs: write a README #13

KnorpelSenf opened this issue Jun 11, 2023 · 6 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@KnorpelSenf
Copy link
Member

It's inadequate, we all know it
@rojvv
Copy link
Member

rojvv commented Jun 12, 2023 •
edited
Loading

I prefer one like https://github.com/grammyjs/translations-bot.

@KnorpelSenf
Copy link
Member Author

In other words, you want to provide no documentation?

@rojvv
Copy link
Member

rojvv commented Jun 12, 2023

Yes.

@roziscoding roziscoding added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jun 12, 2023
@roziscoding
Copy link
Collaborator

What should the README say, tho?

@rojvv
Copy link
Member

rojvv commented Jun 12, 2023 •
edited
Loading

A simple sentence should be fine for now. Here’s an example:

Filename: README.md

A work-in-progress collection of web-based tools for bot developers.

I literally mean this:

echo "A work-in-progress collection of web-based tools for bot developers.\n" > README.md

@KnorpelSenf
Copy link
Member Author

I agree that would be better than the current README. I do not agree that this is sufficient.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@roziscoding @KnorpelSenf @rojvv