[READ-ONLY] a fast, modern browser for the npm registry

docs: add clarity around naming and target audience (#843)

authored by

Salma Alam-Naylor and committed by
GitHub
f8228f17 c295d194

+20 -6
+18 -4
CONTRIBUTING.md
··· 8 8 9 9 ## Goals 10 10 11 - We want to create 'a fast, modern browser for the npm registry.' This means, among other things: 11 + The goal of [npmx.dev](https://npmx.dev) is to build a fast, modern and open-source browser for the npm registry, prioritizing speed, simplicity and a community-driven developer experience. 12 + 13 + ### Core values 12 14 13 - - We don't aim to replace the [npmjs.com](https://www.npmjs.com/) registry, just provide a better UI and DX. 14 - - Layout shift, flakiness, slowness is The Worst. We need to continually iterate to create the most performant, best DX possible. 15 - - We want to provide information in the best way. We don't want noise, cluttered display, or confusing UI. If in doubt: choose simplicity. 15 + - Speed 16 + - Simplicity 17 + - Community-first 18 + 19 + ### Target audience 20 + 21 + npmx is built for open-source developers, by open-source developers. 22 + 23 + Our goal is to create tools and capabilities that solve real problems for package maintainers and power users, while also providing a great developer experience for everyone who works in the JavaScript ecosystem. 24 + 25 + This focus helps guide our project decisions as a community and what we choose to build. 16 26 17 27 ## Table of Contents 18 28 ··· 148 158 To help with this, the project uses `oxfmt` to handle formatting via a pre-commit hook. The hook will automatically reformat files when needed. If something can’t be fixed automatically, it will let you know what needs to be updated before you can commit. 149 159 150 160 If you want to get ahead of any formatting issues, you can also run `pnpm lint:fix` before committing to fix formatting across the whole project. 161 + 162 + ### npmx name 163 + 164 + When displaying the project name anywhere in the UI, use `npmx` in all lowercase letters. 151 165 152 166 ### TypeScript 153 167
+2 -2
README.md
··· 15 15 16 16 The goal of [npmx.dev](https://npmx.dev) is to build a fast, modern browser for the npm registry. 17 17 18 - We're not replacing the [npmjs.com](https://www.npmjs.com/) registry, but instead providing an elevated developer experience through a fast, modern UI. 18 + We're not replacing the [npm](https://www.npmjs.com/) registry, but instead providing an elevated developer experience through a fast, modern UI. 19 19 20 20 What npmx offers: 21 21 22 22 - **Speed** – Fast searching, filtering, and navigation. 23 23 - **Simplicity** – Get the information you need when you need it in an intuitive UI. 24 - - **Compatibility** – Replace `npmjs.com` with `xnpmjs.com` or `npmx.dev` in any URL and it just works. 24 + - **URL Compatibility** – Replace `npmjs.com` with `xnpmjs.com` or `npmx.dev` in any URL and it just works. 25 25 - **Enhanced admin experience** – Manage your packages, teams, and organizations from the browser, powered by your local npm CLI. 26 26 27 27 ## Shortcuts