Update Readme, add Contributing and license

Author: fsgreco

CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contributing to Mock Data Generator
+
+I'd love your input or feedback! I want to make contributing to this project as easy and transparent as possible.
+
+## Development Process
+
+I've tried to set a minumum Test-Driven Development (TDD) flow. Before making any changes:
+
+1. Clone the repository
+2. Install dependencies:
+   ```sh
+   deno install
+   ```
+3. Run the test suite to ensure everything works:
+   ```sh
+   deno test --watch
+   ```
+
+### TDD Workflow
+
+1. Write a failing test first
+2. Run tests to verify it fails (`deno test --watch`)
+3. Implement the minimum code to make it pass
+5. Refactor if needed
+
+## Pull Request Process
+
+1. Fork the repo and create your branch from `main`
+2. Ensure tests pass and add new ones for your changes
+3. Update documentation if needed
+4. Create a Pull Request with a clear description
+
+## Code Style
+
+- Use TypeScript
+- Follow existing code formatting (but don't worry too much, in the future I will set a CI to run `deno fmt` automatically).
+- Keep functions small and focused
+- Add JSDoc comments for public APIs
+
+## Running Tests
+
+Tests are essential in this project. Always run:
+
+```sh
+deno test --watch        # Run tests in watch mode during development
+```
+
+## Questions?
+
+Feel free to open an issue for any questions or concerns.

LICENSE

@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) 2023 Santiago
+
+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

@@ -48,35 +48,42 @@ const users = createRandomUsers(3);
 
 ### Generate Mock Data from a Generator
 
-The `getMocksFromGenerator` function preserves the types of your generator functions:
+The `getMocksFromGenerator` function lets you define your own data generation logic. You provide an object where each property is a function that generates values. You can mix and match:
+- Faker.js functions
+- Your own custom functions
+- Random value generators
+- Fixed value functions
+- Any JavaScript/TypeScript function that returns a value
 
 ```typescript
 import { getMocksFromGenerator } from "@functions/mock";
 import { faker } from "@faker-js/faker";
 
 const yourGenerator = {
+  // Use faker functions directly
   id: faker.string.uuid,
-  name: faker.person.firstName,
-  age: () => faker.number.int({ min: 18, max: 99 }),
+  // Your own random logic
+  age: () => Math.floor(Math.random() * 100),
+  // Mix calculated and faker values
+  username: () => `user_${faker.number.int(1000)}`,
+  // Fixed values
+  role: () => 'user',
+  // Complex custom logic
+  status: () => {
+    const statuses = ['active', 'inactive', 'pending'];
+    return statuses[Math.floor(Math.random() * statuses.length)];
+  }
 };
 
 const createRandomObjects = getMocksFromGenerator(yourGenerator);
-// TypeScript infers exact return types from your generator functions
+// TypeScript should infers return types from your generator functions
 const objects = createRandomObjects(5);
 // objects is typed as Array<{ id: string; name: string; age: number }>
 ```
 
+## Contributing
 
-
-### `getMocksFromGenerator`
-
-Type-safe generator that creates mock data from a predefined generator.
-
-**Parameters:**
-- `gen`: An object where keys are property names and values are functions that generate the property values. Types are automatically inferred from your generator functions.
-
-**Returns:**
-- A strongly-typed function that generates an array of mock objects with exact property types.
+This is a Test-Driven Development (TDD) project. Please read the [Contributing Guidelines](CONTRIBUTING.md) for details on development process and how to submit pull requests.
 
 ## License