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

Readme isn’t explcit enough #149

Closed
Ladet02 opened this issue Nov 7, 2021 · 5 comments
Closed

Readme isn’t explcit enough #149

Ladet02 opened this issue Nov 7, 2021 · 5 comments

Comments

@Ladet02
Copy link

Ladet02 commented Nov 7, 2021

Description

I would suggest a better readme by adding examples (use case) and snippets, to make it more beginner friendly.
@adamchainz
Copy link
Owner

Can you make a PR rather than a one line issue?

@adamchainz
Copy link
Owner

adamchainz commented Nov 7, 2021 •
edited
Loading

Did you check out the example app?

@Ladet02
Copy link
Author

Ladet02 commented Nov 7, 2021

No I haven’t, I would though. But I’m saying not everyone who checks the package would want to go through the example app.

@Ladet02 Ladet02 closed this as completed Nov 10, 2021
@Nebucatnetzer
Copy link

One thing which I tripped over was that I had to add htmx to the static files by myself.
Maybe the README could be extended to mention that?
Or explicitly state what it tries to do and what it doesn't try to do?

@adamchainz
Copy link
Owner

I've added a note about setting up htmx in #172.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@adamchainz @Nebucatnetzer @Ladet02