diff --git a/README.md b/README.md index 7aaf5429d..1a421dc97 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,16 @@ ## Vision -The aim of [npmx.dev](https://npmx.dev) is to provide a better browser for the npm registry – fast, modern, and accessible. We don't aim to replace the [npmjs.com](https://www.npmjs.com/) registry, just provide a better UI, DX, and admin experience. +The goal of [npmx.dev](https://npmx.dev) is to build a fast, modern browser for the npm registry. -- **Speed first** – Layout shift, flakiness, slowness is The Worst. Fast searching, filtering, and navigation. -- **URL compatible** – Replace `npmjs.com` with `xnpmjs.com` or `npmx.dev` in any URL and it just works. -- **Simplicity** – No noise, cluttered display, or confusing UI. If in doubt: choose simplicity. -- **Admin UI** – Manage your packages, teams, and organizations from the browser, powered by your local npm CLI. +We're not replacing the [npmjs.com](https://www.npmjs.com/) registry, but instead providing an elevated developer experience through a fast, modern UI. + +What npmx offers: + +- **Speed** – Fast searching, filtering, and navigation. +- **Simplicity** – Get the information you need when you need it in an intuitive UI. +- **Compatibility** – Replace `npmjs.com` with `xnpmjs.com` or `npmx.dev` in any URL and it just works. +- **Enhanced admin experience** – Manage your packages, teams, and organizations from the browser, powered by your local npm CLI. ## Shortcuts @@ -36,7 +40,7 @@ The aim of [npmx.dev](https://npmx.dev) is to provide a better browser for the n ### Package browsing -- **Dark mode by default** – easier on the eyes +- **Dark mode and light mode** – plus customize the color palette to your preferences - **Fast search** – quick package search with instant results - **Package details** – READMEs, versions, dependencies, and metadata - **Code viewer** – browse package source code with syntax highlighting and permalink to specific lines @@ -100,7 +104,7 @@ The aim of [npmx.dev](https://npmx.dev) is to provide a better browser for the n ### npm compatibility -npmx.dev supports npm permalinks – just replace `npmjs.com` with `npmx.dev` or `xnpmjs.com` and it works: +npmx.dev supports npm permalinks – just replace `npmjs.com` with `npmx.dev` or `xnpmjs.com` to get the npmx experience: | npm URL | npmx.dev equivalent | | ------------------------------- | ---------------------------------------------------------------------- | @@ -142,7 +146,7 @@ npmx.dev also supports shorter, cleaner URLs: ## Contributing -We welcome contributions – please do feel free to poke around and improve things. See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to get up and running! +We welcome contributions – please do feel free to explore the project and improve things. See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to get up and running! ## Related projects @@ -151,6 +155,7 @@ We welcome contributions – please do feel free to poke around and improve - [npm-userscript](https://github.com/bluwy/npm-userscript) – Browser userscript with various improvements and fixes for npmjs.com - [npm-alt](https://npm.willow.sh/) – An alternative npm package browser - [npkg.lorypelli.dev](https://npkg.lorypelli.dev/) – An alternative frontend to npm made with as little client-side JavaScript as possible +- [vscode-npmx](https://github.com/npmx-dev/vscode-npmx) – VSCode extension for npmx If you're building something cool, let us know! 🙏