Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jeasonstudio committed Jun 20, 2024
1 parent 350131e commit 790e739
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 15 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ on:
- pull_request

jobs:
unit-test-and-lint:
build-and-test-coverage:
runs-on: ubuntu-latest

steps:
Expand Down
52 changes: 44 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,48 @@
# Chrome AI
<div align="center">
<a name="readme-top"></a>

`jeasonstudio/chrome-ai` is a community provider that uses Chrome built-in AI to provide language model. It works fine with vercel `ai`.
<h1>Chrome AI</h1>

[Vercel AI](https://sdk.vercel.ai/docs/introduction) provider for Chrome built-in model (Gemini Nano).

[![NPM version][npm-image]][npm-url]
[![NPM downloads][download-image]][download-url]
[![Stargazers][stars-shield]][stars-url]
[![MIT License][license-shield]][license-url]

[![CI status][github-action-image]][github-action-url]
[![codecov][codecov-image]][codecov-url]
[![Follow Twitter][twitter-image]][twitter-url]

[Report Bug](https://github.com/jeasonstudio/chrome-ai/issues/new) · [Pull Request](https://github.com/jeasonstudio/chrome-ai/compare)

![](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)

[npm-image]: https://img.shields.io/npm/v/chrome-ai?style=for-the-badge
[npm-url]: http://npmjs.org/package/chrome-ai
[download-image]: https://img.shields.io/npm/dm/chrome-ai.svg?style=for-the-badge
[download-url]: https://npmjs.org/package/chrome-ai
[github-action-image]: https://img.shields.io/github/actions/workflow/status/jeasonstudio/chrome-ai/ci.yml?style=for-the-badge
[github-action-url]: https://github.com/jeasonstudio/chrome-ai/actions?query=workflow=%22ci%22
[codecov-image]: https://img.shields.io/codecov/c/github/jeasonstudio/chrome-ai/main.svg?style=for-the-badge
[codecov-url]: https://codecov.io/gh/jeasonstudio/chrome-ai/branch/main
[license-shield]: https://img.shields.io/github/license/jeasonstudio/chrome-ai.svg?style=for-the-badge
[license-url]: https://github.com/jeasonstudio/chrome-ai/blob/main/LICENSE

[stars-shield]: https://img.shields.io/github/stars/jeasonstudio/chrome-ai.svg?style=for-the-badge
[stars-url]: https://github.com/jeasonstudio/chrome-ai/stargazers
[issues-shield]: https://img.shields.io/github/issues/jeasonstudio/chrome-ai.svg?style=for-the-badge
[issues-url]: https://github.com/jeasonstudio/chrome-ai/issues
[twitter-image]: https://img.shields.io/twitter/follow/jeasonstudio?style=for-the-badge&logo=x
[twitter-url]: https://twitter.com/jeasonstudio

</div>

## Installation

```bash
$ npm i ai chrome-ai
```

## Enable AI in Chrome

Expand All @@ -14,12 +56,6 @@ Then click `Optimization Guide On Device Model` in [chrome://components/](chrome

Finally, you can use prompt api in console, or use `chrome-ai` with `vercel/ai` to build projects.

## Install

```bash
npm install chrome-ai ai
```

## Usage

generate text:
Expand Down
5 changes: 2 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "chrome-ai",
"description": "Vercel AI provider for Chrome built-in model (Gemini Nano)",
"version": "1.1.2",
"main": "./dist/index.js",
"module": "./dist/index.mjs",
Expand All @@ -19,15 +20,13 @@
"files": [
"dist"
],
"author": "jeason.eth <me@cowpoke.cc>",
"author": "jeasonstudio <me@cowpoke.cc>",
"license": "MIT",
"description": "",
"dependencies": {
"@ai-sdk/provider": "^0.0.10",
"debug": "^4.3.5"
},
"devDependencies": {
"@ai-sdk/provider-utils": "^0.0.13",
"@types/debug": "^4.1.12",
"@vitest/coverage-v8": "^1.6.0",
"ai": "^3.1.31",
Expand Down
3 changes: 0 additions & 3 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 790e739

Please sign in to comment.