Skip to content

Commit ffd1392

Browse files
committed
chore: remove outdated documentation files
- Deleted CONTRIBUTING.md, FIRST_RELEASE.md, index.ts, install.sh, knowledge.config.example.json, and related sections in README.md to streamline the project and remove obsolete content.
1 parent 07af5b1 commit ffd1392

File tree

7 files changed

+11
-277
lines changed

7 files changed

+11
-277
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 83 deletions
This file was deleted.

FIRST_RELEASE.md

Lines changed: 0 additions & 104 deletions
This file was deleted.

README.md

Lines changed: 10 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,17 @@
2020
## 📦 Installation
2121

2222
```bash
23+
# Global installation (recommended)
2324
npm install -g @riligar/knowledge
25+
26+
# Or with bun
27+
bun add -g @riligar/knowledge
28+
29+
# Or with yarn
30+
yarn global add @riligar/knowledge
31+
32+
# Or with pnpm
33+
pnpm add -g @riligar/knowledge
2434
```
2535

2636
## 🎯 Quick Start
@@ -45,44 +55,6 @@ npm install -g @riligar/knowledge
4555

4656
Visit our [official documentation](https://myknowledge.click) for detailed guides and examples.
4757

48-
## 🤝 Contributing
49-
50-
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
51-
52-
### Commit Convention
53-
54-
This project uses [Conventional Commits](https://www.conventionalcommits.org/) for automated versioning and changelog generation. Please format your commits as:
55-
56-
```
57-
feat: add new feature
58-
fix: resolve bug
59-
docs: update documentation
60-
```
61-
62-
## 🔄 Release Process
63-
64-
Releases are fully automated using semantic-release:
65-
66-
- **Automatic versioning** based on commit messages
67-
- **Changelog generation** from conventional commits
68-
- **NPM publishing** on every release
69-
- **GitHub releases** with detailed notes
70-
71-
Simply push to the `prod` branch and let the automation handle the rest!
72-
73-
## 📄 License
74-
75-
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
76-
77-
## 🌟 Support
78-
79-
- 📧 Email: maciel.ciro@icloud.com
80-
- 🐛 Issues: [GitHub Issues](https://github.com/riligar/knowledge/issues)
81-
- 💬 Discussions: [GitHub Discussions](https://github.com/riligar/knowledge/discussions)
82-
83-
---
84-
85-
Made with ❤️ by [Riligar](https://riligar.click)
8658

8759
## 🚀 How to Use (3 Steps)
8860

index.ts

Lines changed: 0 additions & 9 deletions
This file was deleted.

install.sh

Lines changed: 0 additions & 41 deletions
This file was deleted.

package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@
3737
"build-bin": "bun build src/cli.ts --outdir bin --target node --format esm",
3838
"prepare-npm": "node scripts/prepare-npm.js",
3939
"prepublishOnly": "bun run build-bin && npm run prepare-npm",
40-
"test": "echo \"No tests specified\" && exit 0",
4140
"semantic-release": "semantic-release",
4241
"test-release": "./scripts/test-release.sh"
4342
},
@@ -79,4 +78,4 @@
7978
"@semantic-release/github": "^11.0.0",
8079
"@semantic-release/npm": "^12.0.1"
8180
}
82-
}
81+
}

0 commit comments

Comments
 (0)