placer-toolkit 1.0.0-alpha.4 → 1.0.0-alpha.5

package/README.md

@@ -1,6 +1,6 @@
-<!-- SPDX-License-Identifier: MIT AND CC-BY-4.0 AND CC-BY-ND-4.0 -->
+<!-- SPDX-License-Identifier: MIT -->
 
-# <picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/placer-toolkit/placer-toolkit/refs/heads/main/public/logo-wordmark-dark.svg"></source><source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/placer-toolkit/placer-toolkit/refs/heads/main/public/logo-wordmark-light.svg"></source><img src="https://raw.githubusercontent.com/placer-toolkit/placer-toolkit/refs/heads/main/public/logo-wordmark-light.svg" alt="Placer Toolkit" width="50%" /></picture>
+# <picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/placer-toolkit/placer-toolkit/refs/heads/main/packages/placer-toolkit/public/logo-wordmark-dark.svg"></source><source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/placer-toolkit/placer-toolkit/refs/heads/main/packages/placer-toolkit/public/logo-wordmark-light.svg"></source><img src="https://raw.githubusercontent.com/placer-toolkit/placer-toolkit/refs/heads/main/packages/placer-toolkit/public/logo-wordmark-light.svg" alt="Placer Toolkit" width="50%" /></picture>
 
 ### Flexible. Accessible. Web Components.
 
@@ -22,48 +22,28 @@ If you want to create custom builds of Placer Toolkit, you can use this document
 
 You don’t need any of this to use Placer Toolkit. This section is for contributors or anyone who wants to tinker with the source or create custom builds of Placer Toolkit.
 
-1. Start by [forking the repo](https://github.com/placer-toolkit/placer-toolkit/fork) on GitHub, then clone it locally and install dependencies.
+Start by [forking the repo](https://github.com/placer-toolkit/placer-toolkit/fork) on GitHub, then clone it locally and install dependencies.
 
-```shell
+```bash
 git clone https://github.com/placer-toolkit/placer-toolkit
 cd placer-toolkit # Navigates into your clone
-npm install # Installs dependencies for Placer Toolkit
-cd docs
-npm install # Installs dependencies for Placer Toolkit’s docs
+pnpm install # Installs dependencies
 ```
 
-2. Once you’ve cloned the repo, you can run the following command to spin up the development server for the docs. Make sure you’re in the `docs` folder of the project.
+Once you’ve cloned the repo, you can run the following command to spin up the development server for the docs and the library compilation watcher.
 
-```shell
-npm run dev # Spins up the dev server provided by Astro
-npx astro dev --host # If you want to expose the server on your network
+```bash
+pnpm dev # Spins up the dev server provided by Astro
+pnpm dev --host # If you want to expose the dev server on your network
 ```
 
-This will spin up the dev server on `localhost:4321`. There isn’t any hot module reloading as Web Components aren’t compatible with this technology, but it’ll automatically refresh the page instead.
-
-3. To build the docs, run this command in the `docs` folder.
-
-```shell
-npm run build # Builds the project. Also initialises Pagefind on‐the‐go
-npm run preview # Spins up the production server provided by Astro
-```
-
-## 📄 Licence
-
-This project uses a modular licensing system and different parts of the codebase are licensed under different licences.
-
-- **Library:** MIT License
-- **Documentation:** CC BY 4.0
-- **Logos:** CC BY-ND 4.0 with exceptions listed in the [Brand assets guidelines](https://placer-toolkit.vercel.app/docs/resources/brand-assets)
-- **Branding and marketing assets:** All rights reserved with a contributor licence grant
-
-See the [licence page](https://placer-toolkit.vercel.app/docs/legal/licence) for more information.
+This will spin up the dev server on `localhost:4321`.
 
 ## 💖 Special thanks
 
 Placer Toolkit was built with the help of these fantastic libraries:
 
-- [Lit](https://lit.dev)
+- [Lit](https://lit.dev)w
 - [Astro](https://astro.build)
 - [Floating UI](https://floating-ui.com)
 - [Custom Elements Manifest](https://custom-elements-manifest.open-wc.org)
@@ -75,4 +55,15 @@ The default icon set is [Font Awesome](https://fontawesome.com) which is license
 
 For the entire list of open‐source libraries and frameworks, see [THIRD-PARTY-NOTICES.md](./THIRD-PARTY-NOTICES.md) for more information.
 
+## 📄 Licence
+
+This project uses a modular licensing system and different parts of the codebase are licensed under different licences.
+
+- **Library:** MIT License
+- **Documentation:** CC BY 4.0
+- **Logos:** CC BY-ND 4.0 with exceptions listed in the [Brand assets guidelines](https://placer-toolkit.vercel.app/docs/resources/brand-assets)
+- **Branding and marketing assets:** All rights reserved with a contributor licence grant
+
+See the [licence page](https://placer-toolkit.vercel.app/docs/legal/licence) for more information.
+
 © 2025–present Placer and its contributors