Merge pull request #9 from EvanZhouDev/v2

✨ Gemini AI v2

Author: EvanZhouDev

.github/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing
+
+Thank you for taking the time to contribute!
+
+## Techstack
+
+Gemini AI is built with the following tools. Ensure you have `bun` [installed](https://bun.sh/).
+
+- [**Bun**](https://bun.sh/) as the package manager
+- [**Biome**](https://biomejs.dev/) as the linter and formatter
+- [**tsup**](https://tsup.egoist.dev/) as the build tool
+
+Follow the [Github flow](https://docs.github.com/en/get-started/using-github/github-flow) to clone the repo and create a branch.
+
+It is recommended to install Biome integration with your IDE to format your code.
+
+## Scripts
+
+### `bun run build`
+
+Use this to build your project, should you need to test it locally.
+
+It uses `tsup` under the hood.
+
+### `bun run test`
+
+Use this to test your project with existing unit tests. These tests will also be ran on your PR, so ensure they are passing!
+
+It uses `vitest` under the hood.
+
+You can also use `bun run coverage` to check coverage of your tests.
+
+### `bun run check`
+
+Use this to check if your code follows our formatting standards.
+
+It uses Biome under the hood.

.github/README.md

@@ -1,3 +1,4 @@
 /node_modules
 .DS_Store
-/coverage
+/coverage
+/dist

.gitignore

@@ -2,4 +2,8 @@
 /coverage
 /.github
 /test
-/bun.lockb
+/bun.lockb
+/src
+tsconfig.json
+tsup.config.ts
+biome.json

.npmignore

@@ -5,10 +5,10 @@
     <img alt="" src="https://img.shields.io/npm/v/gemini-ai.svg?label=NPM&logo=npm&style=for-the-badge&color=0470FF&logoColor=white">
   </a>
   <a aria-label="NPM Download Count" href="https://www.npmjs.com/package/gemini-ai">
-    <img alt="" src="https://img.shields.io/npm/dt/gemini-ai?label=Downloads&style=for-the-badge&color=67ACF3">
+    <img alt="" src="https://img.shields.io/npm/dt/gemini-ai?label=Downloads&style=for-the-badge&color=27B2FF">
   </a>
-  <a aria-label="palm-api Size" href="https://www.npmjs.com/package/gemini-ai">
-    <img alt="" src="https://img.shields.io/bundlephobia/minzip/gemini-ai?style=for-the-badge&color=F9DBBC">
+  <a aria-label="Gemini AI Size" href="https://www.npmjs.com/package/gemini-ai">
+    <img alt="" src="https://img.shields.io/bundlephobia/minzip/gemini-ai?style=for-the-badge&color=B3CAFF">
   </a>
 </p>
 <p align="center">
@@ -17,7 +17,8 @@
 
 ## Quickstart
 
-Make a text request (`gemini-pro`):
+
+Make a text request:
 
 ```javascript
 import Gemini from "gemini-ai";
@@ -27,7 +28,7 @@ const gemini = new Gemini(API_KEY);
 console.log(await gemini.ask("Hi!"));
 ```
 
-Make a streaming text request (`gemini-pro`):
+Make a streaming text request:
 
 ```javascript
 import Gemini from "gemini-ai";
@@ -39,7 +40,7 @@ gemini.ask("Hi!", {
 });
 ```
 
-Chat with Gemini (`gemini-pro`):
+Chat with Gemini:
 
 ```javascript
 import Gemini from "gemini-ai";

README.md

@@ -10,6 +10,6 @@
 		}
 	},
 	"files": {
-		"ignore": ["coverage"]
+		"ignore": ["coverage", "dist"]
 	}
 }