Skip to content

Commit 9c118bb

Browse files
committed
docs: improve readme
1 parent 65e68b1 commit 9c118bb

File tree

3 files changed

+61
-2
lines changed

3 files changed

+61
-2
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
<!-- markdownlint-capture -->
22
<!-- markdownlint-disable no-inline-html first-line-h1 heading-start-left -->
33
<div align="center">
4-
<img src="./assets/logo.svg" alt="apr" width="200" />
4+
<a href="https://github.com/cli-stuff/apr">
5+
<img src="./assets/logo.svg" alt="apr" width="200" />
6+
</a>
57

68
# apr
79

@@ -25,6 +27,12 @@ Just run `apr` in any directory containing a `package.json`:
2527
apr
2628
```
2729

30+
### 📸 Screenshot
31+
32+
<!-- markdownlint-disable-next-line no-inline-html -->
33+
<img src="./assets/example.png" alt="screenshot" width="600" />
34+
35+
2836
## ✨ Features
2937

3038
- 📦 Beautiful terminal UI
@@ -33,6 +41,20 @@ apr
3341
- 🎨 Colored output for better readability
3442
- 🚀 Zero configuration needed
3543

44+
## ❤️ Support
45+
46+
If you like this project, consider supporting it by starring ⭐ it on GitHub, sharing it with your friends, or buying me a coffee ☕:
47+
48+
- https://send.monobank.ua/jar/6rUVs4yasg
49+
- https://donatello.to/okineadev
50+
51+
## 🙏 Credits
52+
53+
Thanks to these packages, this project works:
54+
55+
- [ink](https://github.com/vadimdemedes/ink) - React for CLIs
56+
- [ink-divider](https://github.com/JureSotosek/ink-divider) - Divider component for Ink
57+
3658
## 📝 License
3759

38-
MIT
60+
MIT © [Okinea Dev](https://github.com/okineadev)

assets/example.png

43.1 KB
Loading

examples/package.json

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
{
2+
"name": "some-cool-package",
3+
"version": "0.8.2",
4+
"description": "🚀 A modern toolkit for building awesome things",
5+
"main": "src/index.ts",
6+
"type": "module",
7+
"private": false,
8+
"author": {
9+
"name": "Example Developer",
10+
"email": "dev@example.com",
11+
"url": "https://example.com"
12+
},
13+
"license": "MIT",
14+
"homepage": "https://github.com/example/some-cool-package",
15+
"bugs": {
16+
"url": "https://github.com/example/some-cool-package/issues",
17+
"email": "support@example.com"
18+
},
19+
"repository": {
20+
"type": "git",
21+
"url": "git+https://github.com/example/some-cool-package.git"
22+
},
23+
"keywords": ["cool", "awesome", "toolkit", "typescript", "modern", "bun"],
24+
"scripts": {
25+
"test": "bun test",
26+
"start": "bun run src/index.ts",
27+
"check": "biome check .",
28+
"format": "biome format ."
29+
},
30+
"dependencies": {
31+
"react": "^18.2.0"
32+
},
33+
"devDependencies": {
34+
"@biomejs/biome": "1.4.1",
35+
"bun-types": "latest"
36+
}
37+
}

0 commit comments

Comments
 (0)