docs: Updating licence & contribution guidelines (#91)

* Updated licence

* Updated docs, added more details regarding contributions

Author: xBlaz3kx

CONTRIBUTING.md

@@ -6,18 +6,50 @@ We love your input! We want to make contributing to this project as easy and tra
 - Discussing the current state of the code
 - Submitting a fix
 - Proposing new features
+- Adding support for new hardware
 - Becoming a maintainer
 
-## Making changes to the code
+## Naming conventions
 
-Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
+Be sure to follow the naming conventions used throughout the project (e.g., variable names, function names, file names,
+etc.).
 
-1. Fork the repo and create your branch from `main`.
-2. If you've added code that should be tested, add tests.
-3. If you've changed APIs, update the documentation.
-4. Ensure the test suite passes.
-5. Make sure your code lints.
-6. Issue that pull request!
+Also make sure the commit messages are clear and concise, following
+the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+
+## Reporting issues
+
+If you find a bug in the project, please open an issue on the project's GitHub repository. When opening an issue, please
+provide as much information as possible, including the version of the project you are using, the operating system you
+are using, and any relevant error messages and logs.
+
+### New features
+
+If you would like to contribute code to the project, please follow these steps:
+
+1. Fork the project on GitHub.
+2. Create a new branch for your changes.
+3. Make your changes on the new branch.
+4. Write tests for your changes.
+5. Run the tests to make sure they pass.
+6. Submit a pull request to the project's GitHub repository.
+7. Create necessary documentation for your changes, for example, how to use the new feature, how to configure it and
+   preferably design docs.
+
+That's it! We will review your pull request and provide feedback as soon as possible.
+
+### Hardware support
+
+If you would like to add support for new hardware to the project, please follow these steps:
+
+1. Fork the project on GitHub.
+2. Create a new branch for your changes.
+3. Make your changes on the new branch.
+4. Write tests for your changes.
+5. Run the tests to make sure they pass and perform necessary hardware tests.
+6. Submit a pull request to the project's GitHub repository.
+7. Create documentation for the new hardware, describing features, installation and usage.
+8. (Optional) Write some guidelines on how to use, handle and maintain the new hardware.
 
 ## Any contributions you make will be under the MIT Software License
 

LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021-2023 Blaž Dular
+Copyright (c) 2021-2025 The ChargePi project
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

ReadMe.md

@@ -28,8 +28,12 @@ connecting to the backend.
 - **Easy replication** - ChargePi is easy to replicate. It can be deployed on a Raspberry Pi or any other Linux-based
   device. Configurations can be easily exported from an existing device to other devices.
 - **Hardware-agnostic** - ChargePi supports a variety of hardware components. You can mix and match the hardware
-  components to create a charging station that suits your needs.
-- **API** - ChargePi comes with an API that allows you to integrate it with other systems.
+  components to create a charging station that suits your needs. You can also write custom drivers for currently
+  unsupported hardware. We are always looking for contributors to add support for new hardware components.
+- **Modular** - ChargePi is modular, allowing you to add or remove components as needed, based on your use case. You can
+  easily add new hardware components or functionalities to your charging station.
+- **API** - ChargePi comes with an API that allows you to integrate it with other systems or implement custom
+  functionality.
 
 ## Roadmap
 
@@ -114,8 +118,10 @@ Client comes with default settings which require minimal configuration.
 
 ## Contributing
 
-Contributions are welcome! Please check out the [contributing guide](/docs/contributing/contributing.md) for more
-information.
+Contributions are welcome! Whether you want to add support for new hardware components, improve the documentation,
+found a bug or have an idea for a new feature, we appreciate your help!
+
+Please check out the [contributing guide](/docs/contribution/contributing.md) for more information on how to contribute.
 
 ## License
 

docs/configuration/configuration.md

@@ -97,7 +97,7 @@ chargePoint:
     maxPower: 11
     maxChargingTime: 5
     ocpp:
-      vendor: UL FE
+      vendor: ChargePi
       model: ChargePi
 
   logging:

docs/contribution/client/api.md

@@ -12,8 +12,5 @@ on `localhost:4269`.
 Compiling the protobuf:
 
 ```bash
-protoc --go_out=./internal/api --go_opt=paths=source_relative \
-    --proto_path=pkg/proto \
-    --go-grpc_out=./internal/api --go-grpc_opt=paths=source_relative \
-    pkg/proto/*.proto
+buf generate
 ```