You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+13-4Lines changed: 13 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,11 +8,16 @@ Thank you for your interest in contributing! ❤️ This document provides guide
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 browser for the npm registry.
12
12
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
+
We're not replacing the [npmjs.com](https://www.npmjs.com/) registry, but instead providing an elevated developer experience through a fast, modern UI.
14
+
15
+
What npmx offers:
16
+
17
+
-**Speed**– Fast searching, filtering, and navigation.
18
+
-**Simplicity**– Get the information you need when you need it in an intuitive UI.
19
+
-**Compatibility**– Replace `npmjs.com` with `xnpmjs.com` or `npmx.dev` in any URL and it just works.
20
+
-**Enhanced admin experience**– Manage your packages, teams, and organizations from the browser, powered by your local npm CLI.
16
21
17
22
## Table of Contents
18
23
@@ -148,6 +153,10 @@ To help with this, the project uses `oxfmt` to handle formatting via a pre-commi
148
153
149
154
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.
150
155
156
+
### npmx name
157
+
158
+
If adding the name of the project to anywhere in the UI, use `npmx` in all lowercase letters.
159
+
151
160
### TypeScript
152
161
153
162
- We care about good types – never cast things to `any` 💪
0 commit comments