chore: update the readme #29
Conversation
Update the README.md file to reflect the current state of the project. This includes adding a section on how to build and contribute to the project and updates the note about who is currently maintaining the project. This change-set also removes the CHANGELOG.md file as most Deno projects don't include this and it was mostly a change log of the Astro project.
|
|
| You can also check our [Astro Integration Documentation][astro-integration] for | ||
| more on integrations. | ||
| To configure your development environment, clone the repository and install | ||
| [`pnpm`](https://pnpm.io/). `pnpm` is a package manager that emphasizes disk |
There was a problem hiding this comment.
Do you prefer to use pnpm? I'm personally in favor of getting rid of pnpm settings (Currently the repo has both pnpm-lock.yaml and package-lock.json and that feels confusing to me)
There was a problem hiding this comment.
I don't prefer pnpm, but when I tried npm i the build / test didn't work. I just tried it again, and it seems you get errors related to "File not found". I assumed that we rely on the pnpm disk layout vs the one that npm uses.
Also pnpm is the tool used in the GitHub CI, so this keeps the developers setup closer to that of GitHub. Maybe we can take a pass at removing pnpm and using npm (or even moving to Deno 2.0 and using Deno to provision the dependencies).
There was a problem hiding this comment.
There is also a deno.lock file ;). I guess we don't need the package-lock.json? Should we remove that one, assuming that we really do need pnpm to build this project right now?
There was a problem hiding this comment.
Ok. Let's revisit that in later PRs
|
NPM link to the changelog should be removed: https://www.npmjs.com/package/@deno/astro-adapter#changelog |
Good catch. Actually that entire page is out-of-date. I've updated the README, but it's not reflected there. I wonder who has access to update the NPM description. |
Update the README.md file to reflect the current state of the project. This includes adding a section on how to build and contribute to the project and updates the note about who is currently maintaining the project.
This change-set also removes the CHANGELOG.md file as most Deno projects don't include this and it was mostly a change log of the Astro project.