docs: add basic readme

Author: danielroe

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Daniel Roe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,75 +1,88 @@
-# Nuxt 3 Minimal Starter
+# npmx.dev
 
-Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
+> A fast, modern npm package browser for power users.
 
-## Setup
+<p align="center">
+  <a href="https://npmx.dev/">
+    <img width="1090" alt="Screenshot of npmx.dev showing the nuxt package" src="https://github.com/user-attachments/assets/229497a2-8491-461c-aa1d-fba981215340">
+  </a>
+</p>
 
-Make sure to install the dependencies:
+- [👉 &nbsp;Check it out](https://npmx.dev/)
 
-```bash
-# npm
-npm install
+## Vision
 
-# pnpm
-pnpm install
+The aim of [npmx.dev](https://npmx.dev) is to provide a better npm package browsing experience - fast, accessible, and designed for power users.
 
-# yarn
-yarn install
+- **Speed first** - Insanely fast searching, filtering, and navigation.
+- **URL compatible** - Replace `npmjs.com` with `xnpmjs.com` or `npmx.dev` in any URL and it just works.
+- **Provenance aware** - See at a glance which packages have verified build provenance.
 
-# bun
-bun install
-```
+## Features
 
-## Development Server
+- **Package browsing** - Fast search, package details, READMEs, versions, dependencies
+- **User profiles** - View any npm user's public packages at `/~username`
+- **Organization pages** - Browse org packages at `/org/orgname`
+- **Provenance indicators** - Verified build indicators for packages with npm provenance
 
-Start the development server on `http://localhost:3000`:
+### URL Compatibility
 
-```bash
-# npm
-npm run dev
+npmx.dev supports npm permalink patterns:
 
-# pnpm
-pnpm run dev
+| Pattern | Example |
+|---------|---------|
+| `/package/<name>` | [`/package/nuxt`](https://npmx.dev/package/nuxt) |
+| `/package/@scope/name` | [`/package/@nuxt/kit`](https://npmx.dev/package/@nuxt/kit) |
+| `/package/<name>/v/<version>` | [`/package/vue/v/3.4.0`](https://npmx.dev/package/vue/v/3.4.0) |
+| `/search?q=<query>` | [`/search?q=vue`](https://npmx.dev/search?q=vue) |
+| `/~<username>` | [`/~sindresorhus`](https://npmx.dev/~sindresorhus) |
+| `/org/<name>` | [`/org/nuxt`](https://npmx.dev/org/nuxt) |
 
-# yarn
-yarn dev
+## Tech Stack
 
-# bun
-bun run dev
-```
+- [Nuxt 4](https://nuxt.com/) - Vue framework
+- [Nitro](https://nuxt.com/docs/guide/concepts/server-engine) - Server engine with API routes
+- [UnoCSS](https://unocss.dev/) - Atomic CSS engine
+- [nuxt-og-image](https://github.com/nuxt-modules/og-image) - Dynamic OG images
+- [npm Registry API](https://github.com/npm/registry/blob/main/docs/REGISTRY-API.md) - Package data
 
-## Production
+## Try it out locally
 
-Build the application for production:
+### Setup
 
 ```bash
-# npm
-npm run build
+# install dependencies
+corepack enable
+pnpm install
 
-# pnpm
-pnpm run build
+# serve in dev mode, with hot reload at localhost:3000
+pnpm dev
 
-# yarn
-yarn build
+# build for production
+pnpm build
 
-# bun
-bun run build
+# preview in production mode
+pnpm preview
 ```
 
-Locally preview production build:
+### Testing
 
 ```bash
-# npm
-npm run preview
+# run all tests
+pnpm test
 
-# pnpm
-pnpm run preview
+# run unit tests
+pnpm test:unit
 
-# yarn
-yarn preview
+# run e2e tests
+pnpm test:browser
 
-# bun
-bun run preview
+# type check
+pnpm test:types
 ```
 
-Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
+## License
+
+Made with ❤️
+
+Published under [MIT License](./LICENSE).