Skip to content

docs: add clarity around naming and target audience #843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
danielroe merged 11 commits into from
Feb 3, 2026
Merged

docs: add clarity around naming and target audience #843

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
1532b07
Update contributing
whitep4nth3r Feb 3, 2026
0ce152d
Update word
whitep4nth3r Feb 3, 2026
8cb7330
Clarify URL compatibility
whitep4nth3r Feb 3, 2026
fafefa2
Update mentions of npm
whitep4nth3r Feb 3, 2026
feabfdb
Update contributing
whitep4nth3r Feb 3, 2026
a1c0b65
coderabbit suggestion
whitep4nth3r Feb 3, 2026
57cc1a7
Merge branch 'main' into name-clarity
whitep4nth3r Feb 3, 2026
3314778
Add target audience
whitep4nth3r Feb 3, 2026
ae99e88
Merge branch 'main' into name-clarity
whitep4nth3r Feb 3, 2026
b0ee7a4
fix spelling
whitep4nth3r Feb 3, 2026
ee552c7
Update target audience
whitep4nth3r Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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` 💪
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading