Skip to content

Commit f8228f1

Browse files
authored
docs: add clarity around naming and target audience (#843)
1 parent c295d19 commit f8228f1

File tree

2 files changed

+20
-6
lines changed

2 files changed

+20
-6
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,21 @@ Thank you for your interest in contributing! ❤️ This document provides guide
88
99
## Goals
1010

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.
1212

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.
13+
### Core values
14+
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.
1626

1727
## Table of Contents
1828

@@ -149,6 +159,10 @@ To help with this, the project uses `oxfmt` to handle formatting via a pre-commi
149159

150160
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.
151161

162+
### npmx name
163+
164+
When displaying the project name anywhere in the UI, use `npmx` in all lowercase letters.
165+
152166
### TypeScript
153167

154168
- We care about good types – never cast things to `any` 💪

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@
1515

1616
The goal of [npmx.dev](https://npmx.dev) is to build a fast, modern browser for the npm registry.
1717

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.
1919

2020
What npmx offers:
2121

2222
- **Speed** – Fast searching, filtering, and navigation.
2323
- **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.
2525
- **Enhanced admin experience** – Manage your packages, teams, and organizations from the browser, powered by your local npm CLI.
2626

2727
## Shortcuts

0 commit comments

Comments
 (0)