Skip to content

Commit 150da5d

Browse files
authored
Merge pull request #2 from GIMMI42PIASTRATO/feat/add-readme
add README.md
2 parents 37134f1 + 484def7 commit 150da5d

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# NPKG 🚀
2+
3+
**NPKG** is a fast and efficient alternative to the slow npm website. If you're tired of sluggish page loads and inefficient browsing on npm's official site, npkg is here to offer you a lightning-fast experience for exploring packages, managing dependencies, and copying useful scripts.
4+
5+
### Key Features 🌟
6+
- **Blazing Fast** ⚡: Experience a smooth and fast interface compared to the traditional npm website.
7+
- **Intuitive UI** 🖥️: Designed to be user-friendly and efficient, helping you find packages and scripts quickly.
8+
- **Package Browsing** 🔍: Quickly browse, search, and explore npm packages with minimal latency.
9+
- **Copy Commands & Scripts** 📋: Easily copy installation commands or commonly used scripts like `test`, `lint`, and others.
10+
11+
## Getting Started 🚀
12+
13+
To start using **NPKG**, simply visit the website:
14+
15+
[**npkg.lorypelli.dev**](https://npkg.lorypelli.dev/)
16+
17+
## Usage 🛠️
18+
19+
Once on the website, you can:
20+
21+
- **Search for Packages** 🔎: Quickly search for npm packages by name, keyword, or description.
22+
- **View Package Details** 📦: See detailed information about each package, including versions, readmes, dependencies, and available scripts.
23+
- **Copy Installation Commands** ⬇️: Grab npm or yarn installation commands with a single click.
24+
- **Copy Scripts** 📝: Easily copy common npm scripts like `test`, `lint`, `build`, and more directly from the package's `package.json`.
25+
26+
## Why NPKG? 🤔
27+
28+
**NPKG** is built for speed and convenience. Not only does it make browsing the npm ecosystem faster, but it also simplifies copying essential commands and scripts, saving you time when setting up or working with packages.
29+
30+
## Website 🌐
31+
32+
Start using NPKG today at:
33+
[**npkg.lorypelli.dev**](https://npkg.lorypelli.dev/)
34+
35+
## License 📜
36+
37+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
38+
39+
---
40+
41+
Contributions and feedback are always welcome! 🙌

0 commit comments

Comments
 (0)