Updated readme; Added license, security and code of conduct files

Author: korridor

CODE_OF_CONDUCT.md

@@ -0,0 +1,42 @@
+# Code of Conduct
+
+The goal is to create a community that is open and welcoming to all individuals.
+To achieve this, we have developed a code of conduct that outlines the expectations for behavior of all members of our community.
+
+## Pledge
+
+This community is founded on respect and understanding.
+All members are expected to treat others with respect and empathy, and to not tolerate any form of discrimination,
+harassment, or attacks.
+
+## Expectations
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate
+and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
+issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily
+or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Contact
+
+If you feel uncomfortable or believe that someone has violated the code of conduct, please contact us at [[email protected]](mailto:[email protected]).
+We will thoroughly investigate the incident and aim for the best possible outcome.

LICENSE.md

@@ -0,0 +1,26 @@
+The MIT License (MIT)
+=====================
+
+Copyright © `2024` `Gregor Vostrak & Constantin Graf`
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the “Software”), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+

README.md

@@ -1,41 +1,49 @@
-# solidtime Documentation
+# solidtime | Documentation
 
-This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+solidtime is a modern open-source time tracking application for freelancers and agencies.
 
-### Installation
+This repository contains the documentation for solidtime.
+The documentation is built using [Docusaurus](https://docusaurus.io/).
 
-```
-$ yarn
+## Installation
+
+First, clone the repository:
+
+```bash
+git clone [email protected]:solidtime-io/docs.git
 ```
 
-### Local Development
+Then, install the dependencies:
 
+```bash
+npm install
 ```
-$ yarn start
+### Local Development
+
+```bash
+npm run start
 ```
 
 This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+Some features, like search and the API page, won't work in the local development environment. If you want to test this, you need to build the documentation and serve from the `build` directory.
 
 ### Build
 
-```
-$ yarn build
+```bash
+npm run build
 ```
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+This command generates static content into the build directory.
+You can test the build by running a local HTTP server:
 
-### Deployment
-
-Using SSH:
-
-```
-$ USE_SSH=true yarn deploy
+```bash
+npm run serve
 ```
 
-Not using SSH:
+## Contributing
 
-```
-$ GIT_USER=<Your GitHub username> yarn deploy
-```
+Contributions to the documentation are welcome.
+
+## License
 
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+The documentation is licensed under the MIT License. See [LICENSE](LICENSE.md) for more information.

SECURITY.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability regarding this project, please e-mail me to [[email protected]](mailto:[email protected])!