Browse Source

some info in readme

boyska 7 months ago
parent
commit
65a6d413cb
1 changed files with 9 additions and 7 deletions
  1. 9 7
      README.md

+ 9 - 7
README.md

@@ -1,22 +1,24 @@
 # plaid
 
-### TODO:
+This is an advanced radio player webapp based on [radiomanifest](https://radiomanifest.degenerazione.xyz/).
+The goal is to support most features of "radio-specific" apps (schedule, live listening, past espisodes), while being generic and supporting multiple apps.
+
+Support for PWA is planned but not implemented.
 
-- [ ] il player lo controllerei con un event handler, cosi' da dove vuoi lanci $emit('play', questo): https://v3-migration.vuejs.org/breaking-changes/events-api.html#_2-x-syntax
 
 ## Install Dependencies
 
-First of all we need to install dependencies, run in terminal
+First of all we need to install dependencies, so run this:
 
-```
+```sh
 npm install
 ```
 
 ## NPM Scripts
 
-- 🔥 `start` - run development server
-- 🔧 `dev` - run development server
-- 🔧 `build` - build web app for production
+- `npm run start` - run development server
+- `npm run dev` - run development server
+- `npm run build` - build web app for production
 
 ## Vite