Skip to content

Commit de64ea4

Browse files
committed
Update README with project description and features
1 parent 64e4f5b commit de64ea4

File tree

1 file changed

+25
-54
lines changed

1 file changed

+25
-54
lines changed

README.md

Lines changed: 25 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,25 @@
1-
# React + TypeScript + Vite
2-
3-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
4-
5-
Currently, two official plugins are available:
6-
7-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
8-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
9-
10-
## Expanding the ESLint configuration
11-
12-
If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
13-
14-
```js
15-
export default tseslint.config({
16-
extends: [
17-
// Remove ...tseslint.configs.recommended and replace with this
18-
...tseslint.configs.recommendedTypeChecked,
19-
// Alternatively, use this for stricter rules
20-
...tseslint.configs.strictTypeChecked,
21-
// Optionally, add this for stylistic rules
22-
...tseslint.configs.stylisticTypeChecked,
23-
],
24-
languageOptions: {
25-
// other options...
26-
parserOptions: {
27-
project: ['./tsconfig.node.json', './tsconfig.app.json'],
28-
tsconfigRootDir: import.meta.dirname,
29-
},
30-
},
31-
})
32-
```
33-
34-
You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
35-
36-
```js
37-
// eslint.config.js
38-
import reactX from 'eslint-plugin-react-x'
39-
import reactDom from 'eslint-plugin-react-dom'
40-
41-
export default tseslint.config({
42-
plugins: {
43-
// Add the react-x and react-dom plugins
44-
'react-x': reactX,
45-
'react-dom': reactDom,
46-
},
47-
rules: {
48-
// other rules...
49-
// Enable its recommended typescript rules
50-
...reactX.configs['recommended-typescript'].rules,
51-
...reactDom.configs.recommended.rules,
52-
},
53-
})
54-
```
1+
# npm Version Popularity
2+
3+
A web tool to analyze npm package version popularity based on download counts. This tool helps developers make informed decisions about which package versions to use in their projects.
4+
5+
## Features
6+
7+
- 📊 View download counts for all versions of any npm package
8+
- 🔍 Filter versions using semver ranges (e.g., "^1.0.0", "~2.0.0")
9+
- 📈 Compare version popularity through visual indicators
10+
- 🌗 Dark/Light theme support
11+
12+
## Getting Started
13+
14+
1. Clone the repository
15+
2. Install dependencies: `npm install`
16+
3. Start the development server: `npm start`
17+
18+
Visit [http://localhost:3000](http://localhost:3000) to view the application.
19+
20+
## Built With
21+
22+
- React
23+
- TypeScript
24+
- Ant Design
25+
- npm Registry API

0 commit comments

Comments
 (0)