updated documentation

Author: iChristwin

CONTRIBUTING.MD

@@ -0,0 +1,40 @@
+## Contributing to m3ters.js: Building Clarity Together
+
+We welcome contributions from passionate developers like you to help evolve m3ters.js and make it an even more powerful tool for interacting with the M3tering Protocol. We encourage contributions of all types, whether it's fixing bugs, adding new features, improving documentation, or simply suggesting ideas.
+
+**Before you dive in, please take a moment to familiarize yourself with these guidelines:**
+
+**Getting Started:**
+
+* **Fork the repository:** Head over to the m3ters.js GitHub repository and click the "Fork" button. This creates a copy of the codebase in your own account, allowing you to make changes and submit them for review.
+* **Set up your development environment:** Make sure you have Node.js (version 19 or above) and npm installed on your system. Then, clone your forked repository locally and install the dependencies:
+
+```bash
+git clone https://github.com/your-username/m3ters.js
+cd m3ters.js
+npm install
+```
+
+* **Branching strategy:** We use feature branches for all bug fixes and new features. Please create a new branch for your contribution based on the `main` branch, and name it descriptively using the format `feature/your-contribution-name`.
+
+**Making Changes:**
+
+* **Follow our coding style:** We use Prettier and ESLint to maintain consistent code formatting and quality. Please run `npm run lint` before committing your changes to ensure they adhere to our conventions.
+* **Write clear and concise commit messages:** Your commit messages should briefly explain what you changed and why. Use a subject line that summarizes the change followed by a body that provides more details.
+* **Unit tests:** If you're adding new functionality, please write unit tests to ensure it works as expected. We use Jest for our unit testing framework.
+
+**Submitting your Contribution:**
+
+* **Push your changes to your forked repository:** Once you're happy with your changes, push them to your feature branch on your forked repository.
+* **Create a pull request:** Head over to your forked repository on GitHub and create a pull request from your feature branch to the `main` branch of the upstream repository. Be sure to provide a clear and concise description of your changes in the pull request description.
+* **Engage in the review process:** We encourage discussion and feedback on pull requests. Be patient and responsive to any comments or questions from the maintainers.
+
+**Additional points to remember:**
+
+* **Stay respectful and professional:** We strive to maintain a welcoming and inclusive community. Please treat everyone with respect and avoid any discriminatory or offensive language.
+* **Be mindful of scope:** Try to keep your pull requests focused on a single issue or feature. Larger changes should be broken down into smaller, more manageable pieces.
+* **Don't hesitate to ask for help:** If you encounter any problems or have any questions, feel free to reach out to the maintainers for assistance. We're happy to help!
+
+**We appreciate your contributions to m3ters.js! Together, we can make it even better.**
+
+**Happy coding!**

README.md

@@ -1,22 +1,92 @@
 # `m3ters.js`
-React toolkit tailored to M3tering Protocol for handling ugly crypto strings
 
-## Features
-- **[M3ter Alias](./docs/m3ter-alias.md#m3ter-alias): Human-Readable Hashes:** Easily convert complex cryptographic strings into easily understandable and visually appealing human-readable hashes.
+Introducing m3ters.js, a React toolkit meticulously crafted to empower developers with seamless management of complex cryptographic strings within the M3tering Protocol.
 
-- **[M3ter Head](./docs/m3ter-head.md#M3ter-Head): Unique SVG Avatars** Generate one-of-a-kind SVG avatars that serve as distinctive visual representations for device DIDs and blockchain address strings commonly encountered in the M3tering Protocol.
+This versatile library empowers developers with:
 
-## Installation
+- **Seamless Integration:** Effortlessly incorporate m3ters.js components and functions into your React projects, streamlining development and reducing complexity.
 
-1. Add the `m3ters.js` component to your project using npm:
+- **Protocol Adherence:** Interact with M3tering Protocol elements confidently, ensuring compliance with protocol-specific requirements and best practices.
 
-   ```bash
-   npm install m3ters --save
-   ```
+## Featured React Components
+
+### [M3ter Alias](./docs/m3ter-alias.md#m3ter-alias): Transform Unwieldy Identifiers
+
+Effortlessly convert those eye-straining crypto strings into captivating and user-friendly aliases, seamlessly integrated within your React applications. Representing IDs in a way you can actually remember.
+
+### [M3ter Head](./docs/m3ter-head.md#M3ter-Head): Unique SVG Avatars
+
+Generate unique and captivating SVG avatars that serve as visual representations for device DIDs and blockchain addresses, enhancing user engagement and brand recognition.
+
+## Installation Options
+
+m3ters.js offers flexible installation methods to cater to your preferred workflow:
+
+### 1. Using a Package Manager:
+
+Open your terminal or command prompt and navigate to your project's root directory. Then, execute the following command:
+
+- **npm:** `npm i --save m3ters`
+- **yarn:** `yarn add m3ters`
+
+If you prefer a package manager other than npm or yarn, you can also try:
+
+- **pnpm:** `pnpm install m3ters`
+- **Bower:** `bower install m3ters`
+
+### 2. CDN Link:
+
+- Include the following script tag in your HTML file:
+
+```html
+<script src="https://unpkg.com/m3ters@latest/dist/m3ters.min.js"></script>
+```
+
+### 3. Direct Download:
+
+- Access the m3ters.js repository on GitHub: [here](https://github.com/iChristwin/m3ters.js/releases)
+- Download the latest `.zip` or `.tar.gz` file containing the library source code.
+- Extract the contents into your project's directory.
+- Import components directly from the extracted files.
+
+## Usage
+
+Added the React components from `m3ters.js` into code via named imports
+
+```javascript
+import { M3terAlias, M3terHead } from "m3ters";
+```
+
+See [M3ter Alias](./docs/m3ter-alias.md#m3ter-alias) and [M3ter Head](./docs/m3ter-head.md#M3ter-Head) for more usage documentation.
+
+## Compatibility
+
+The library was developed, tested and is guaranteed to function properly on
+
+- node `19.0.0`
+- npm: `9.8.1`
+- react: `18.2.0`
+
+Should also be compatible with all major desktop and mobile browsers including but not limited to
+
+- Firefox
+- Chrome
+- Edge
+- Brave
+- Waterfox
 
 ## Example App
 
-Check out my [demo m3ters](https://github.com/ichristwin/demo-m3ters) for a sample React project incorporating the `m3ters.js` library. Additionally, you can experience the live implementation of `m3ters.js` at https://m3ters.ichristwin.com.
+Check out the my example GitHub repo, [ichristwin/demo-m3ters](https://github.com/ichristwin/demo-m3ters). You could also experience the live implementation of at https://m3ters.ichristwin.com
 
 ### Other projects using `m3ters.js`
- - 
+
+-
+
+## Contributing
+
+See the [contributing docs](./CONTRIBUTING.MD) for more information on how to contribute code.
+
+## Licensing
+
+You are free to embed under the terms of the [CC0 1.0 Universal](./LICENSE) License.

docs/m3ter-alias.md

@@ -11,7 +11,7 @@ Effortlessly create captivating names that instantly distinguish each device, an
    import { M3terAlias } from "m3ters";
    ```
 
-2. Render the alias within your component, providing a unique seed string for generation:
+2. Render the alias within your component, providing your input string for conversion:
 
    ```jsx
    export default function Home() {
@@ -30,7 +30,6 @@ Effortlessly create captivating names that instantly distinguish each device, an
 
 Inspired by a similar JavaScript library, [angry-purple-tiger](https://github.com/helium/angry-purple-tiger) developed by [Andrew Allen](https://twitter.com/allenan_) for the Helium Network.
 
-
 ## Licensing
 
 You are free to embed under the terms of the [CC0 1.0 Universal](./LICENSE) License.