Skip to content

Commit 4c8897d

Browse files
authored
Merge pull request #95 from KellyLTran/improve-readme
2 parents 1d0f486 + 3a67c3f commit 4c8897d

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@ openSquat
22
====
33
![alt text](https://raw.githubusercontent.com/atenreiro/opensquat/master/screenshots/openSquat_logo.png)
44

5+
## Table of Contents
6+
- [What is openSquat](#what-is-opensquat)
7+
- [Screenshot / Video Demo](#screenshot--video-demo)
8+
- [Demo / Forks](#demo--forks)
9+
- [How to Install](#how-to-install)
10+
- [How to Update](#how-to-update)
11+
- [Usage Examples](#usage-examples)
12+
- [Automations & Integrations](#automations--integrations)
13+
- [To Do / Roadmap](#to-do--roadmap)
14+
- [Changelog](#changelog)
15+
- [How to Contribute](#how-to-contribute)
16+
- [Authors](#authors)
17+
- [How to Help](#how-to-help)
18+
519
What is openSquat
620
-------------
721

@@ -140,14 +154,21 @@ To Do / Roadmap
140154
* AND logical condition for keywords search (e.g: google+login) - Thanks to Steff T.
141155
* Enhanced documentation
142156

143-
Feature Request
144-
-------------
145-
To request a new feature, create a "new issue" and describe the feature and potential use cases. You can upvote the "issue" and contribute to the discussions if something similar already exists.
146-
147157
Changelog
148158
-------------
149159
* Check the [CHANGELOG](https://github.com/atenreiro/opensquat/blob/master/CHANGELOG) file.
150160

161+
How to Contribute
162+
-------------
163+
We welcome and encourage contributions from the community! If you're interested in helping improve openSquat, here are a variety of ways you can contribute:
164+
165+
- **Reporting Bugs:** To report bugs, open an issue on our [GitHub issues page](https://github.com/atenreiro/opensquat/issues). You should include as much detail as possible to help us understand the problem and what the ideal solution would be.
166+
- **Feature Requests:** To request a new feature, create a "new issue" and describe the feature and potential use cases. You can upvote the "issue" and contribute to the discussions if something similar already exists.
167+
- **Code Contributions:** To help advance openSquat with coding, you can look at open issues or feature requests. Be sure to fork the repository, make your changes, and submit a pull request.
168+
- **Documentation:** You can help improve documentation by fixing typos, clarifying instructions, or adding new, valuable sections.
169+
170+
Thank you for your interest in contributing to openSquat!
171+
151172
Authors
152173
-------------
153174
Project founder
@@ -157,7 +178,7 @@ Project founder
157178
Contributors
158179
* Please check the contributors page on GitHub
159180

160-
How to help
181+
How to Help
161182
-------------
162183
You can help this project in many ways:
163184
* Providing your time and coding skills to enhance the project

0 commit comments

Comments
 (0)