From 2928bd4079aa50bd58adc9057c8cd58d53b21372 Mon Sep 17 00:00:00 2001
From: qpismont <pismont.quentin@protonmail.com>
Date: Thu, 19 Oct 2023 22:07:44 +0200
Subject: [PATCH] add readme + mit licence

---
 LICENSE |  7 ++++++
 README  | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 78 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 README

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..837c5b0
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,7 @@
+Copyright 2023 qpismont
+
+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.
diff --git a/README b/README
new file mode 100644
index 0000000..d9400b7
--- /dev/null
+++ b/README
@@ -0,0 +1,71 @@
+# nano-service
+
+`nano-service` is a lightweight, efficient messaging library written in TypeScript, enabling seamless communication between services using message brokers. It is designed to integrate with the NATS messaging system, providing an easy-to-use API to create a robust microservices environment.
+
+## Prerequisites
+
+Before you begin, ensure you have met the following requirements:
+
+- You have installed Node.js 20 or higher. You can download and install Node.js from [nodejs.org](https://nodejs.org/).
+- You have a working knowledge of TypeScript.
+- You have access to a NATS server (if you're planning to use the library in a production environment).
+
+## Development
+
+To start working with `nano-service`, you need to clone the project and use it in your TypeScript applications. Follow these steps:
+
+### Clone the repository
+
+Start by cloning the `nano-service` repository to your local machine. Use the following command:
+
+```bash
+git clone https://gitea.qpismont.fr/qpismont/nano-service
+```
+
+### Navigate to the cloned repository
+
+```bash
+cd nano-service
+```
+
+### Link the library
+In the `nano-service` directory, use npm to create a symbolic link to the library globally on your system:
+
+```bash
+npm link
+```
+
+This command makes the `nano-service` library available globally on your machine.
+
+### Using nano-service in your project
+
+Navigate to your project's directory where you want to use `nano-service`. You can then link the globally linked `nano-service` library to your project using the following command:
+
+```bash
+npm link nano-service
+```
+
+This command links the `nano-service` package to your project, allowing you to import and use it in your TypeScript files.
+
+### Testing
+
+This project uses Jest for testing. To run tests, navigate to the project directory and run:
+
+```bash
+npm run test
+```
+
+Ensure any new code contributions are well-tested through Jest.
+
+### Linting
+
+The project utilizes `ESLint` to maintain a consistent, high-quality codebase. To lint the project, execute:
+
+```bash
+npm run lint
+```
+
+Please ensure your contributions adhere to the established ESLint rules.
+
+## License
+`nano-service` is available under the MIT License. See the LICENSE file for more info.
\ No newline at end of file