Skip to content

Commit 29ecae5

Browse files
committed
Update README
1 parent 306d537 commit 29ecae5

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,16 @@
1313

1414
## Vision
1515

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

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.
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:
21+
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.
2226

2327
## Shortcuts
2428

@@ -36,7 +40,7 @@ The aim of [npmx.dev](https://npmx.dev) is to provide a better browser for the n
3640

3741
### Package browsing
3842

39-
- **Dark mode by default** – easier on the eyes
43+
- **Dark mode by default** – and customize the color palette to your preferences
4044
- **Fast search** – quick package search with instant results
4145
- **Package details** – READMEs, versions, dependencies, and metadata
4246
- **Code viewer** – browse package source code with syntax highlighting and permalink to specific lines
@@ -100,7 +104,7 @@ The aim of [npmx.dev](https://npmx.dev) is to provide a better browser for the n
100104

101105
### npm compatibility
102106

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:
104108

105109
| npm URL | npmx.dev equivalent |
106110
| ------------------------------- | ---------------------------------------------------------------------- |
@@ -142,7 +146,7 @@ npmx.dev also supports shorter, cleaner URLs:
142146

143147
## Contributing
144148

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!
146150

147151
## Related projects
148152

@@ -151,6 +155,7 @@ We welcome contributions – please do feel free to poke around and improve
151155
- [npm-userscript](https://github.com/bluwy/npm-userscript) – Browser userscript with various improvements and fixes for npmjs.com
152156
- [npm-alt](https://npm.willow.sh/) – An alternative npm package browser
153157
- [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
154159

155160
If you're building something cool, let us know! 🙏
156161

0 commit comments

Comments
 (0)