diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index fc3b55524..3a64913db 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -40,5 +40,5 @@ jobs: - uses: EndBug/add-and-commit@v9 if: github.ref == 'refs/heads/main' with: - message: "Bump package version [skip ci]" + message: 'Bump package version [skip ci]' default_author: github_actions diff --git a/.vscode/settings.json b/.vscode/settings.json index 5535f40f2..d5a0e184e 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -23,5 +23,8 @@ }, "[markdown]": { "editor.defaultFormatter": "esbenp.prettier-vscode" - } + }, + "[yaml]": { + "editor.defaultFormatter": "esbenp.prettier-vscode" + } } diff --git a/README.md b/README.md index bc08abab4..8ec92e88b 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,27 @@ _The Modrinth component library, in Svelte_ Read the documentation at [omorphia.modrinth.com.](https://omorphia.modrinth.com) -Requires Node v16.5+. - ## Developing -The library lives in the `package/` folder, and the documentation lives in the `docs/` folder. +The library lives in the `src/` folder, and the documentation lives in the `docs/` folder. + +### Getting started + +Install [Node (16.5+)](https://docs.volta.sh/guide/getting-started) and [PNPM](https://pnpm.io/installation) prior to developing. + +To start the dev server, install dependencies and run `pnpm dev`: ```bash pnpm install # Install dependencies pnpm dev # Run dev server ``` +To use the git hooks in the repo, which will save you waiting for CI to tell you that you forgot to lint, run this: + +```bash +git config core.hookspath .githooks +``` + ### Adding new components > Replace `ComponentName` with your component name in the steps below @@ -39,12 +49,6 @@ pnpm dev # Run dev server ``` ```` -## Packaging - -```bash -pnpm package -``` - ## Building To build the documentation site, run: