diff --git a/README.md b/README.md index b6465f9..4d2023e 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,13 @@ -# PWA Whisper Starter +# Phi 3 PWA -[**Straight to Full Documentation**](https://docs.pwabuilder.com/#/starter/quick-start) +This is an example of using [ONNXRuntime](https://onnxruntime.ai/) in a PWA to run Phi 3 on the GPU of your device. -The PWABuilder Whisper pwa-starter is based on our opinionated, best practices, production tested starter that we use to build all of our PWAs, including [PWABuilder itself](https://blog.pwabuilder.com/posts/introducing-the-brand-new-pwa-builder/)! The pwa-starter is a starter codebase, just like create-react-app or the Angular CLI can generate, that uses the PWABuilder team's preferred front-end tech stack. We also have a CLI tool to allow you to create a PWA template from the command line. +This app also uses the [Fluent Web Components Beta](https://web-components.fluentui.dev/?path=/docs/concepts-introduction--page) to achieve a Windows native look and feel for the PWA. -This "Whisper" version of the starter sets you up with all the code you need to use Whisper to transcribe audio and video, on your device using [transformers.js](https://huggingface.co/docs/transformers.js/index), which uses [Onnxruntime](https://onnxruntime.ai/) to run Whisper client-side on your device, no cloud needed. +## Run the Example +- git clone https://github.com/pwa-builder/pwa-phi3.git +- cd pwa-phi3 +- npm install +- npm run dev +- The app will open in your browser -## Jump Right In - -After you have cloned this starter to your machine, run through the following steps. - -Install Dependencies: - -`npm install` - -And then start developing your app with: - -`npm run dev` - -With that command, the app will open in the browser and will update when you make changes to the code. -And that's it! Good luck on your Progressive Web App adventure! - -## More Info - -[![Get started with the pwa-starter!](https://img.youtube.com/vi/u3pWKpmic_k/0.jpg)](https://www.youtube.com/watch?v=u3pWKpmic_k) - -With it you get an app that: -- Has no build system to set up and no boilerplate code to add. Everything is included out of the box. -- Has a Service Worker system using [Workbox](https://developers.google.com/web/tools/workbox/) -- Scores close to 100 on Lighthouse out of the box -- Has everything needed to be installable in the browser -- Is ready to be package for the app stores using [PWABuilder](https://www.pwabuilder.com) -- Uses the [Azure Static Web Apps CLI](https://azure.github.io/static-web-apps-cli) which enables emulating your production environment locally, and gets you ready for deploying to Azure Static Web Apps! - -and all with just a few button clicks 😊.