Browse Source

misc: Add README.md

develop
Dale 3 months ago
parent
commit
72a7f7e3ba
1 changed files with 16 additions and 0 deletions
  1. +16
    -0
      README.md

+ 16
- 0
README.md View File

@@ -0,0 +1,16 @@
# MiracleTV Shared
Shared types and consts for MiracleTV project


This package is intended to work with

[MiracleTV Backend](https://code.gensokyo.social/Gensokyo.social/miracle-tv) and

[MiracleTV Frontend](https://code.gensokyo.social/Gensokyo.social/miracle-tv-frontend)

## Install

1. Find suitable commit revision
2. Do `yarn add --develop git+https://code.gensokyo.social/Gensokyo.social/miracle-tv.git#{YOUR_REVISION_HASH}` (alternatively, use npm with the same string)
3. import from `miracle-tv-shared/src/types` and `miracle-tv-shared/src/lib`


Loading…
Cancel
Save