add docs and license

Author: bit-web24

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Bittu Kumar
+
+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

@@ -1,92 +1,108 @@
-# gemini_flash
 
-**gemini_flash:** Client for Google's Gemini-1.5-Flash Generative AI Model
 
-This project was bootstrapped by [create-neon](https://www.npmjs.com/package/create-neon).
+# GeminiFlash
 
-## Building gemini_flash
+GeminiFlash is a Node.js library that leverages a Rust backend for generating content using Google's Gemini-1.5-Flash Generative AI Model. This library is designed to be efficient and easy to use, thanks to the power of Rust and the simplicity of JavaScript.
 
-Building gemini_flash requires a [supported version of Node and Rust](https://github.com/neon-bindings/neon#platform-support).
+## Installation
 
-To run the build, run:
+To install the GeminiFlash library, you can use npm:
 
-```sh
-$ npm run build
+```bash
+npm install gemini_flash
 ```
 
-This command uses the [@neon-rs/cli](https://www.npmjs.com/package/@neon-rs/cli) utility to assemble the binary Node addon from the output of `cargo`.
+## Usage
 
-## Exploring gemini_flash
+Here's a basic example of how to use the GeminiFlash library:
 
-After building gemini_flash, you can explore its exports at the Node console:
+```javascript
+const GeminiFlash = require('gemini_flash');
 
-```sh
-$ npm i
-$ npm run build
-$ node
-> require('.').hello()
-'hello node'
+const gemini_flash = new GeminiFlash('api-key-here');
+
+(async () => {
+    try {
+        const prompt = "what is a computer?";
+        const content = await gemini_flash.generate_content(prompt);
+        console.log("Generated Content:", content.text);
+    } catch (error) {
+        console.error("Error:", error);
+    }
+})();
 ```
 
-## Available Scripts
+### API
 
-In the project directory, you can run:
+#### `GeminiFlash`
 
-#### `npm install`
+##### `constructor(api_key)`
 
-Installs the project, including running `npm run build`.
+Creates a new instance of the `GeminiFlash` class.
 
-#### `npm run build`
+- `api_key`: Your API key for the Gemini API.
 
-Builds the Node addon (`index.node`) from source, generating a release build with `cargo --release`.
+##### `generate_content(prompt)`
 
-Additional [`cargo build`](https://doc.rust-lang.org/cargo/commands/cargo-build.html) arguments may be passed to `npm run build` and similar commands. For example, to enable a [cargo feature](https://doc.rust-lang.org/cargo/reference/features.html):
+Generates content based on the given prompt.
 
-```
-npm run build -- --feature=beetle
-```
+- `prompt`: The prompt string to generate content for.
 
-#### `npm run debug`
+**Returns**: A Promise that resolves to an object containing the generated content.
 
-Similar to `npm run build` but generates a debug build with `cargo`.
+### Example
 
-#### `npm run cross`
+```javascript
+const GeminiFlash = require('gemini_flash');
+
+const gemini_flash = new GeminiFlash('your-api-key');
+
+(async () => {
+    try {
+        const prompt = "Explain the concept of artificial intelligence.";
+        const content = await gemini_flash.generate_content(prompt);
+        console.log("Generated Content:", content.text);
+    } catch (error) {
+        console.error("Error:", error);
+    }
+})();
+```
 
-Similar to `npm run build` but uses [cross-rs](https://github.com/cross-rs/cross) to cross-compile for another platform. Use the [`CARGO_BUILD_TARGET`](https://doc.rust-lang.org/cargo/reference/config.html#buildtarget) environment variable to select the build target.
+## Development
 
-#### `npm test`
+### Prerequisites
 
-Runs the unit tests by calling `cargo test`. You can learn more about [adding tests to your Rust code](https://doc.rust-lang.org/book/ch11-01-writing-tests.html) from the [Rust book](https://doc.rust-lang.org/book/).
+- [Node.js](https://nodejs.org/) (v18.20.3 or later)
+- [npm](https://www.npmjs.com/) (v10.7.0 or later)
+- [Rust](https://www.rust-lang.org/)
+- [Neon](https://neon-rs.dev/)
 
-## Project Layout
+### Building the Project
 
-The directory structure of this project is:
+To build the project, run:
 
+```bash
+npm run build
 ```
-gemini_flash/
-├── Cargo.toml
-├── README.md
-├── src/
-|   └── lib.rs
-├── index.node
-├── package.json
-└── target/
+
+### Running Tests
+
+To run the tests, use:
+
+```bash
+npm test
 ```
 
-| Entry          | Purpose                                                                                                                                  |
-|----------------|------------------------------------------------------------------------------------------------------------------------------------------|
-| `Cargo.toml`   | The Cargo [manifest file](https://doc.rust-lang.org/cargo/reference/manifest.html), which informs the `cargo` command.                   |
-| `README.md`    | This file.                                                                                                                               |
-| `src/`         | The directory tree containing the Rust source code for the project.                                                                      |
-| `lib.rs`       | Entry point for the Rust source code.                                                                                                          |
-| `index.node`   | The main module, a [Node addon](https://nodejs.org/api/addons.html) generated by the build and pointed to by `"main"` in `package.json`. |
-| `package.json` | The npm [manifest file](https://docs.npmjs.com/cli/v7/configuring-npm/package-json), which informs the `npm` command.                    |
-| `target/`      | Binary artifacts generated by the Rust build.                                                                                            |
+### Additional Build Scripts
+
+- **Debug build**: `npm run debug`
+- **Release build**: `npm run build`
+- **Cross build**: `npm run cross`
+
+## Contributing
 
-## Learn More
+Contributions are welcome! Please feel free to submit a pull request or open an issue if you find a bug or have a feature request.
 
-Learn more about:
+## License
 
-- [Neon](https://neon-bindings.com).
-- [Rust](https://www.rust-lang.org).
-- [Node](https://nodejs.org).
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package.json

@@ -14,7 +14,7 @@
     "cross": "npm run cross-build -- --release"
   },
   "author": "Bittu Kumar",
-  "license": "ISC",
+  "license": "MIT",
   "devDependencies": {
     "@neon-rs/cli": "0.1.73"
   },