Skip to content

Commit

Permalink
Merge pull request #38 from ainoya/installation-guide
Browse files Browse the repository at this point in the history
Add installation guide to README.md
  • Loading branch information
ainoya authored Nov 18, 2024
2 parents 886ac7a + 3cc2843 commit 08d110c
Show file tree
Hide file tree
Showing 11 changed files with 2,885 additions and 1,490 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ jobs:
uses: actions/setup-node@v4
with:
node-version-file: .node-version
cache: 'npm'
- uses: actions/create-github-app-token@v1
id: app-token
with:
Expand Down Expand Up @@ -57,6 +58,7 @@ jobs:
uses: actions/setup-node@v4
with:
node-version-file: .node-version
cache: 'npm'
- name: Install dependencies
run: npm install
- name: Build
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
name: Test

on:
pull_request_target:
pull_request:
types: [opened, synchronize, reopened]

jobs:
Expand All @@ -17,6 +17,7 @@ jobs:
uses: actions/setup-node@v4
with:
node-version-file: .node-version
cache: 'npm'

- name: Install dependencies
run: npm install
Expand Down
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,17 @@ A Chrome extension that transcribes audio within a browser tab using [transforme
- **Offline Processing**: All transcription is performed locally within the browser.
- **Multi-Language Support**: Supports multiple languages for transcription.

## Install

1. You can use the pre-built `dist.zip` from the releases:
- Download it from [here](https://github.com/ainoya/chrome-extension-web-transcriptor-ai/releases/latest).

2. Load the extension into Chrome:

- Open Chrome and navigate to `chrome://extensions/`.
- Enable "Developer mode" in the top right corner.
- Click "Load unpacked" and select the `dist` directory from this repository or the extracted `dist.zip`.

## Demo

![Demo](./images/chrome-extension-web-transcriptor-ai.gif)
Expand Down
Loading

0 comments on commit 08d110c

Please sign in to comment.