Skip to content

Commit 2657ca0

Browse files
committed
Update README with usage and contributing guide
1 parent 2788772 commit 2657ca0

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -39,19 +39,27 @@ This project is dual-licensed under:
3939

4040
This repository contains documentation files, guides, and resources on various topics. Its purpose is to keep documentation organized, clear, and easy to access.
4141

42-
## Table of Contents
43-
44-
- [About](#about)
45-
- [Usage](#usage)
46-
- [Contributing](#contributing)
47-
- [License](#license)
48-
49-
## About
50-
51-
This repository is intended to be a central hub for documentation. It can include tutorials, examples, notes, and educational resources to help users learn or reference key information.
5242

5343
## Usage
5444

5545
1. Clone the repository:
56-
```bash
5746
git clone https://github.com/Komali0706/docs.git
47+
2. Navigate into the project folder:
48+
cd docs
49+
3. Browse the files and folders to access the documentation.
50+
51+
## Contributing
52+
53+
We welcome contributions! To contribute:
54+
55+
1. Fork the repository.
56+
2. Create a new branch:
57+
git checkout -b your-branch-name
58+
3. Make your changes (edit existing documentation or add new files).
59+
4. Commit your changes:
60+
git commit -m "Add description of changes"
61+
5. Push your branch:
62+
git push origin your-branch-name
63+
6. Open a Pull Request on the original repository.
64+
65+
Make sure all contributions are clear, concise, and relevant.

0 commit comments

Comments
 (0)