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

doc: add use-cases section to readme #367

Merged
merged 6 commits into from
Aug 6, 2023
Merged

doc: add use-cases section to readme #367

merged 6 commits into from
Aug 6, 2023

Conversation

nfriedly
Copy link
Member

@nfriedly nfriedly commented Aug 4, 2023

And rework alternate rate limiters section

Should help to address some of the confusion evidenced in #366 and other tickets

Needs formatting because I just did the editing in github's ui

nfriedly and others added 2 commits August 4, 2023 10:19
And rework alternate rate limiters section

Should help to address some of the confusion evidenced in #366 and other tickets

Needs formatting because I just did the editing in github's ui
@gamemaker1 gamemaker1 changed the title doc: Add use-cases section to readme doc: add use-cases section to readme Aug 4, 2023
@gamemaker1 gamemaker1 added documentation Related to documentation memory-store Related to the built in memory store labels Aug 4, 2023
@nfriedly
Copy link
Member Author

nfriedly commented Aug 4, 2023

I realized I missed a word and a closing parenthesis, and then I ended up making some other changes while I was at it. What do you think about it now?

You can see the rendered html version at https://github.com/express-rate-limit/express-rate-limit/blob/236043254a5bb500269a6417ae044e6081dc1deb/readme.md

@gamemaker1 gamemaker1 added the external-store Related to external stores label Aug 5, 2023
Copy link
Member

@gamemaker1 gamemaker1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@gamemaker1
Copy link
Member

Should we merge this?

readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
@nfriedly
Copy link
Member Author

nfriedly commented Aug 6, 2023

cool, I'm going to merge this and tag it for release

@nfriedly nfriedly merged commit 56de27b into main Aug 6, 2023
36 checks passed
@nfriedly nfriedly deleted the doc-usecases branch August 6, 2023 03:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Related to documentation external-store Related to external stores memory-store Related to the built in memory store
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants