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

Update README to reflect changes in v3 #56

Closed
tcarrio opened this issue Oct 3, 2020 · 3 comments
Closed

Update README to reflect changes in v3 #56

tcarrio opened this issue Oct 3, 2020 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@tcarrio
Copy link

tcarrio commented Oct 3, 2020

Describe the bug
The README notes several key features to the project. From the README:

Features:

Friendly API
No dependencies
0.8 KB minified and gzipped
TypeScript types provided

The second and third bullets are no longer correct.

To Reproduce
Steps to reproduce the behavior:

  1. Go to README
  2. Scroll down to 'Features'
  3. See error

Expected behavior
The updated information on key features with the latest in master.

Screenshots
If applicable, add screenshots to help explain your problem.

Additional context
This should be updated to the correct minified size and no longer include a mention of zero dependencies.

@tcarrio
Copy link
Author

tcarrio commented Oct 4, 2020

Hoping we can figure out a way to get around these issues to continue supporting Deno. While qs might be an easier way for the package to support query parameters, it could be difficult to require dependencies and support Deno. We'll probably have to hold further discussion here or open another issue to track it.

@balazsbotond balazsbotond added the documentation Improvements or additions to documentation label Oct 4, 2020
@balazsbotond
Copy link
Owner

I think we should keep this issue as a reminder to update the README before releasing the next major version.

I've just opened a new issue to discuss Deno support: #74

@balazsbotond balazsbotond changed the title README notes invalid features Update README to reflect changes in v3 Oct 5, 2020
@balazsbotond
Copy link
Owner

Fixed in #190

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

No branches or pull requests

2 participants