Skip to content

Commit 50b5b56

Browse files
committed
Main README file overhaul
1 parent 68921d7 commit 50b5b56

File tree

1 file changed

+36
-9
lines changed

1 file changed

+36
-9
lines changed

README.md

100644100755
Lines changed: 36 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ My vision while creating Ermis was to develop a server-side application that any
2020

2121
## Features
2222

23-
- **Real-time communication:** Efficiently handle multiple concurrent users.
23+
- **Real-time Communication**: Communicate seamlessly with others in real-time.
2424
- **Media Sharing**: Easily share media within your chats.
2525
- **Secure Connections**: Integrated with TLS encryption to ensure privacy and security.
26-
- **PostgreSQL integration:** Manage user data, messages, and logs in a reliable relational database.
26+
- **PostgreSQL Integration**: Manage user data, messages, and logs in a reliable relational database geared towards data integrity.
2727

2828
## Future Enhancements
2929

@@ -112,10 +112,35 @@ To set up the project locally, follow the instructions for each component:
112112

113113
Contributions are welcome! To contribute:
114114

115-
1. Fork the repository.
116-
2. Create a new branch for your feature or bug fix.
117-
3. Ensure your code adheres to the project's style and conventions.
118-
4. Submit a pull request with a detailed description of your changes.
115+
1. **Fork the repository.**
116+
2. **Open a new issue** — if you are intending to fix a bug or feature — describing it thoroughly.
117+
3. **Create a new branch** for your feature or bug fix.
118+
4. **Ensure your code is clean and readable** — at least to some extent.
119+
It doesn't have to be perfect, but aim for clarity, and avoid ambiguity and complexity as much as possible.
120+
121+
Remember:
122+
> _"An idiot admires complexity, while a genius appreciates simplicity"_
123+
> **Terry A. Davis**
124+
>
125+
> _"Truth is ever to be found in simplicity, and not in the multiplicity and confusion of things"_
126+
> **Sir Isaac Newton**
127+
128+
Lastly, try adhering to the most rudimental and basic [programming principles].
129+
130+
> **Note:** if you are wondering what this project's style guide is — it doesn't have one. Nevertheless, if you are looking for a reference of how files should be formatted:
131+
>
132+
> - For code formatting, I have found that [Google's Style guide] is thorough, comprehensive — and broadly applicable.
133+
> - In terms of documentation, I would suggest [Microsoft's Writing Style Guide].
134+
>
135+
> That said, don't sweat too much about following these strictly — I myself probably don't conform to most of their conventions.
136+
137+
5. **Submit a pull request** with a detailed description of your changes — and I may review it eventually.
138+
139+
For further details, see [CONTRIBUTING.md](./CONTRIBUTING.md).
140+
141+
[Microsoft's Writing Style Guide]: https://learn.microsoft.com/en-us/style-guide/welcome
142+
[Google's Style guide]: https://google.github.io/styleguide
143+
[programming principles]: https://github.com/webpro/programming-principles
119144

120145
## Report an issue
121146

@@ -124,15 +149,17 @@ To report bugs, security vulnerabilities, or any other issues for that matter, p
124149
When reporting an issue, please include:
125150
- A clear and descriptive title.
126151
- Steps to reproduce the issue.
127-
- Logs or error messages if available.
128-
- Your environment details (OS, version, etc.).
152+
- Helpful log or error messages if available.
153+
- Your environment details (OS, app version, etc.).
129154

130155
## Authors
131156

132157
* Ilias Koukovinis (2021) [[email protected]]
133158

134159
## License
135160

136-
Ermis is distributed under the GNU Affero General Public License Version 3.0 which can be found in the `LICENSE` file.
161+
Ermis is distributed under the _**GNU Affero General Public License Version 3.0**_ which can be found in the `LICENSE` file.
162+
For a brief synopsis of the license refer to [Wiki](https://github.com/Koukobin/Ermis/wiki/License).
137163

138164
By using this software, you agree to the terms outlined in the license agreement.
165+

0 commit comments

Comments
 (0)