forked from
npmx.dev/npmx.dev
[READ-ONLY]
a fast, modern browser for the npm registry
docs: update readme (#774)
authored by
Salma Alam-Naylor
and committed by
GitHub
06b93d38
f627dd3d
+13
-8
+13
-8
README.md
+13
-8
README.md
···
13
13
14
14
## Vision
15
15
16
-
The aim of [npmx.dev](https://npmx.dev) is to provide a better browser for the npm registry – fast, modern, and accessible. We don't aim to replace the [npmjs.com](https://www.npmjs.com/) registry, just provide a better UI, DX, and admin experience.
16
+
The goal of [npmx.dev](https://npmx.dev) is to build a fast, modern browser for the npm registry.
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.
19
+
20
+
What npmx offers:
17
21
18
-
- **Speed first** – Layout shift, flakiness, slowness is The Worst. Fast searching, filtering, and navigation.
19
-
- **URL compatible** – Replace `npmjs.com` with `xnpmjs.com` or `npmx.dev` in any URL and it just works.
20
-
- **Simplicity** – No noise, cluttered display, or confusing UI. If in doubt: choose simplicity.
21
-
- **Admin UI** – Manage your packages, teams, and organizations from the browser, powered by your local npm CLI.
22
+
- **Speed** – Fast searching, filtering, and navigation.
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.
25
+
- **Enhanced admin experience** – Manage your packages, teams, and organizations from the browser, powered by your local npm CLI.
22
26
23
27
## Shortcuts
24
28
···
36
40
37
41
### Package browsing
38
42
39
-
- **Dark mode by default** – easier on the eyes
43
+
- **Dark mode and light mode** – plus customize the color palette to your preferences
40
44
- **Fast search** – quick package search with instant results
41
45
- **Package details** – READMEs, versions, dependencies, and metadata
42
46
- **Code viewer** – browse package source code with syntax highlighting and permalink to specific lines
···
100
104
101
105
### npm compatibility
102
106
103
-
npmx.dev supports npm permalinks – just replace `npmjs.com` with `npmx.dev` or `xnpmjs.com` and it works:
107
+
npmx.dev supports npm permalinks – just replace `npmjs.com` with `npmx.dev` or `xnpmjs.com` to get the npmx experience:
104
108
105
109
| npm URL | npmx.dev equivalent |
106
110
| ------------------------------- | ---------------------------------------------------------------------- |
···
142
146
143
147
## Contributing
144
148
145
-
We welcome contributions – please do feel free to poke around and improve things. See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to get up and running!
149
+
We welcome contributions – please do feel free to explore the project and improve things. See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to get up and running!
146
150
147
151
## Related projects
148
152
···
151
155
- [npm-userscript](https://github.com/bluwy/npm-userscript) – Browser userscript with various improvements and fixes for npmjs.com
152
156
- [npm-alt](https://npm.willow.sh/) – An alternative npm package browser
153
157
- [npkg.lorypelli.dev](https://npkg.lorypelli.dev/) – An alternative frontend to npm made with as little client-side JavaScript as possible
158
+
- [vscode-npmx](https://github.com/npmx-dev/vscode-npmx) – VSCode extension for npmx
154
159
155
160
If you're building something cool, let us know! 🙏
156
161