Skip to content

Commit 13a54ec

Browse files
committed
Updated readme
1 parent b3b4662 commit 13a54ec

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
1+
![CheckCle Documentation](https://pub-4a4062303020445f8f289a2fee84f9e8.r2.dev/images/checkcle-docs.png)
2+
13
# Welcome to CheckCle Docs
24

3-
**Use your preferred IDE**
5+
👉 **CheckCle Guidelines:** [CheckCle Docs](https://docs.checkcle.io)
6+
7+
# Start Local Development and Improve Documentation
48

59
The only requirement is having Node.js & npm installed - [install with nvm](https://github.com/nvm-sh/nvm#installing-and-updating)
610

711
Follow these steps:
812

913
```sh
1014
# Step 1: Clone the repository using the project's Git URL.
11-
git clone <YOUR_GIT_URL>
15+
git clone https://github.com/operacle/checkcle-docs.git
1216

1317
# Step 2: Navigate to the project directory.
14-
cd checkcle
18+
cd checkcle-docs
1519

1620
# Step 3: Install the necessary dependencies.
1721
npm i
@@ -29,3 +33,19 @@ This project is built with .
2933
- React
3034
- shadcn-ui
3135
- Tailwind CSS
36+
37+
38+
## 🌍 Stay Connected
39+
- Website: [checkcle.io](https://checkcle.io)
40+
- GitHub Repository: ⭐ [CheckCle](https://github.com/operacle/checkcle.git)
41+
- Community Channels: Engage via discussions and issues!
42+
- Discord: Join our community [@discord](https://discord.gg/xs9gbubGwX)
43+
- X: [@tlengoss](https://x.com/tlengoss)
44+
45+
## 📜 License
46+
47+
CheckCle is released under the MIT License.
48+
49+
---
50+
51+
Stay informed, stay online, with CheckCle! 🌐

0 commit comments

Comments
 (0)