diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8f5867e97..8819f243d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,11 +8,21 @@ Thank you for your interest in contributing! ❤️ This document provides guide ## Goals -We want to create 'a fast, modern browser for the npm registry.' This means, among other things: +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. -- We don't aim to replace the [npmjs.com](https://www.npmjs.com/) registry, just provide a better UI and DX. -- Layout shift, flakiness, slowness is The Worst. We need to continually iterate to create the most performant, best DX possible. -- We want to provide information in the best way. We don't want noise, cluttered display, or confusing UI. If in doubt: choose simplicity. +### Core values + +- Speed +- Simplicity +- Community-first + +### Target audience + +npmx is built for open-source developers, by open-source developers. + +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. + +This focus helps guide our project decisions as a community and what we choose to build. ## Table of Contents @@ -148,6 +158,10 @@ To help with this, the project uses `oxfmt` to handle formatting via a pre-commi 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. +### npmx name + +When displaying the project name anywhere in the UI, use `npmx` in all lowercase letters. + ### TypeScript - We care about good types – never cast things to `any` 💪 diff --git a/README.md b/README.md index 1a421dc97..04ddf9c18 100644 --- a/README.md +++ b/README.md @@ -15,13 +15,13 @@ The goal of [npmx.dev](https://npmx.dev) is to build a fast, modern browser for the npm registry. -We're not replacing the [npmjs.com](https://www.npmjs.com/) registry, but instead providing an elevated developer experience through a fast, modern UI. +We're not replacing the [npm](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. +- **URL 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