docs: update readme and contributing guidelines

Author: nimisha-gj

CONTRIBUTING.md

@@ -22,15 +22,24 @@ Create a new branch for your feature or bug fix. Use a descriptive name for your
 git checkout -b feature/your-feature-name
 ```
 
-### 3. Make Your Changes
+### 3. Install Dependencies
+```bash
+npm install
+```
+
+### 4. Make Your Changes
 
 Make the necessary changes to the codebase. Ensure your changes adhere to the project's coding standards.
 
-### 4. Test Your Changes
+### 5. Test Your Changes
 
 Test your changes thoroughly to ensure they work as expected.
+```bash
+npm run lint
+npm test
+```
 
-### 5. Commit Your Changes
+### 6. Commit Your Changes
 
 Commit your changes with a descriptive commit message.
 Make sure to Sign your commits
@@ -40,15 +49,15 @@ git add .
 git commit -m "Add feature: Description of your feature"
 ```
 
-### 6. Push Your Changes
+### 7. Push Your Changes
 
 Push your changes to your forked repository.
 
 ```bash
 git push origin feature/your-feature-name
 ```
 
-### 7. Create a Pull Request
+### 8. Create a Pull Request
 
 Github has documentation on [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
 

README.md

@@ -1,2 +1,70 @@
-# mikrotik-wireguard-client-manager
-A Node.js package for managing WireGuard VPN clients on MikroTik routers via SSH
+A Node.js package for managing WireGuard VPN clients on MikroTik routers via SSH.
+
+**This project has a [Code of Conduct](CODE_OF_CONDUCT.md).**
+
+## Table of contents
+
+* [Installation](#Installation)
+* [Features](#Features)
+* [Running Tests](#Running-Tests)
+* [Contributing](#Contributing)
+* [License](#license)
+
+```js
+const { MikroTikWireGuardClientManager }  = require('@nimisha.gj/mikrotik-client-manager')
+const { MikroTikSSHClient } = require("@nimisha.gj/mikrotik-client-manager");
+
+const sshClient = new MikroTikSSHClient("192.168.1.1", 22, "admin", "password");
+
+const vpnManager = new MikroTikWireGuardClientManager(sshClient);
+const clients = await vpnManager.listClients();
+```
+
+## Installation
+
+This is a [Node.js](https://nodejs.org/en/) module available through the
+[npm registry](https://www.npmjs.com/).
+
+Before installing, [download and install Node.js](https://nodejs.org/en/download/).
+Node.js 22 or higher is required.
+
+If this is a brand new project, make sure to create a `package.json` first with
+the [`npm init` command](https://docs.npmjs.com/creating-a-package-json-file).
+
+Installation is done using the
+[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
+
+```bash
+npm install @nimisha.gj/mikrotik-client-manager
+```
+## Features
+* Add WireGuard Client
+* Remove WireGuard Client
+* List WireGuard Clients
+
+
+### Running Tests
+
+To run the test suite, first install the dependencies:
+
+```bash
+npm install
+```
+
+Then run `npm test`:
+
+```bash
+npm test
+```
+
+## Contributing
+
+The project welcomes all constructive contributions. Contributions take many forms,
+from code for bug fixes and enhancements, to additions and fixes to documentation, additional
+tests, triaging incoming pull requests and issues, and more!
+
+See the [Contributing Guide](CONTRIBUTING.md) for more technical details on contributing.
+
+## License
+
+[MIT](LICENSE)