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

README.md pointing to a version that breaks the example #462

Open
vvrinne opened this issue Jan 31, 2022 · 1 comment
Open

README.md pointing to a version that breaks the example #462

vvrinne opened this issue Jan 31, 2022 · 1 comment

Comments

@vvrinne
Copy link

vvrinne commented Jan 31, 2022

README.md contains the following warning:

" Warning The examples in this README pull from main, which may not make sense to do when you are looking to actually deploy a workload. You would want to "pin" to a particular version which is compatible with the version of Deno you are using and has a fixed set of APIs you would expect. https://deno.land/x/ supports using git tags in the URL to direct you at a particular version. So to use version 3.0.0 of oak, you would want to import https://deno.land/x/oak@v3.0.0/mod.ts."

If you copy the URL pointing to 3.0.0 to replace the main branch URL In the code sample immediately after the warning paragraph it breaks the code, which may be confusing to new users. Update to a newer version number?

@kitsonk
Copy link
Collaborator

kitsonk commented Jan 31, 2022

The whole purpose of point out that it is unversioned is that I don't have to update it every time there is a release or change, so no, I don't really want to update it. I could add "So to use version 3.0.0 of oak (which you don't want to do, you want to use a more recent version), you would want to import..."

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

No branches or pull requests

2 participants