Skip to content

Commit

Permalink
Update raedme and description of the package
Browse files Browse the repository at this point in the history
  • Loading branch information
bragaru-i committed Jan 26, 2024
1 parent 22692fa commit 6dd8295
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 7 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# A File Media Player using HTML `<video />` tag

[Live demo here(Storybook)](https://bragaru-i.github.io/react-compose-player)

~ This is a another media player in react, but with a composition over inheritance pattern.
~ Still in dev mode

## Goal

Goal of this repo is to create a new react media player that will be a composite "lego" player
Expand All @@ -18,9 +23,9 @@ and consumer can use any piece of it, regarding to its own needs and saving by i
- [ ] Create media store on a composite level
- [x] Create a state with `zustand`
- [ ] Emit HTMLMedia events into new created media store
- [ ] Add tests (vitest)
- [ ] Create first version and register it to `npm`
- [ ] Add automatization (Github Actions)
- [ ] Run tests
- [ ] Create storybook on `gihtub pages`
- [ ] Publish new version to `npm`
- [x] Add tests (vitest)
- [x] Create first version and register it to `npm`
- [x] Add automatization (Github Actions)
- [x] Run tests
- [x] Create storybook on `gihtub pages`
- [x] Publish new version to `npm`
12 changes: 11 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"type": "module",
"main": "dist/main.js",
"types": "dist/main.d.ts",
"description": "A react component playing different URL's.",
"files": [
"dist"
],
Expand Down Expand Up @@ -80,5 +81,14 @@
"vite": "^4.5.0",
"vite-plugin-dts": "^3.6.3",
"vitest": "^1.2.1"
}
},
"keywords": [
"react",
"media",
"player",
"video",
"audio",
"react-component",
"composition"
]
}

0 comments on commit 6dd8295

Please # to comment.