Minor edits
This commit is contained in:
parent
c34b4aa66b
commit
36a64e2c03
3 changed files with 34 additions and 34 deletions
4
LICENSE
4
LICENSE
|
@ -1,6 +1,6 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2017-2018 LBRY Inc
|
||||
Copyright (c) 2017-2018 LBRY Inc.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish,
|
||||
|
@ -9,7 +9,7 @@ following conditions:
|
|||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
THE SOFTWARE IS PROVIDED "AS-IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
|
20
README.md
20
README.md
|
@ -1,7 +1,7 @@
|
|||
# Spee.ch
|
||||
Spee.ch is a web app that reads and publishes images and videos to and from the [LBRY](https://lbry.io/) blockchain. You are encouraged to contribute to the shared code base, or fork it and make it your own.
|
||||
Spee.ch is a web app that reads and publishes images and videos to and from the [LBRY](https://lbry.io/) blockchain. You are encouraged to contribute to the shared code base, or fork it and make it your own.
|
||||
|
||||
You can create your own custom version of spee.ch by installing this code base and then creating your own custom components and styles to override the defaults. (More details / guide on how to do that coming soon.)
|
||||
You can create your own custom version of spee.ch by installing this code base and then creating your own custom components and styles to override the defaults. (More details/guide on how to do that coming soon.)
|
||||
|
||||
## Quickstart
|
||||
|
||||
|
@ -11,7 +11,7 @@ _note: this is the quickstart guide, for an in-depth step-by-step overview visit
|
|||
* [node](https://nodejs.org)
|
||||
* [MySQL](https://dev.mysql.com/doc/refman/8.0/en/installing.html)
|
||||
* [`lbry`](https://github.com/lbryio/lbry) daemon
|
||||
* note: retrieve an address from the daemon and send your wallet a couple credits (or join us in the [#speech discord channel](https://discord.gg/YjYbwhS) and we will send you a few)
|
||||
* note: retrieve an address from the daemon and send your wallet a few credits (or join us in the [#speech discord channel](https://discord.gg/YjYbwhS) and we will send you a few)
|
||||
* [FFmpeg](https://www.ffmpeg.org/download.html)
|
||||
|
||||
#### Clone this repo
|
||||
|
@ -41,17 +41,17 @@ _note: make sure lbry is running in the background before proceeding_
|
|||
$ npm run start
|
||||
```
|
||||
|
||||
#### view in browser
|
||||
* visit [http://localhost:3000](http://localhost:3000) in your browser
|
||||
#### View in browser
|
||||
* Visit [http://localhost:3000](http://localhost:3000) in your browser
|
||||
|
||||
#### customize your app
|
||||
#### Customize your app
|
||||
|
||||
check out the [customization guide](https://github.com/lbryio/spee.ch/blob/readme-update/customize.md) to change your app's appearance and components
|
||||
Check out the [customization guide](https://github.com/lbryio/spee.ch/blob/readme-update/customize.md) to change your app's appearance and components
|
||||
|
||||
#### (optional) add custom components and update the styles
|
||||
|
||||
* create custom components by creating React components in `src/views/` (further instructions coming soon)
|
||||
* update the CSS by changing the files in `public/assets/css/` (further instructions and refactor coming soon)
|
||||
* Create custom components by creating React components in `src/views/` (further instructions coming soon)
|
||||
* Update the CSS by changing the files in `public/assets/css/` (further instructions and refactor coming soon)
|
||||
|
||||
#### (optional) Syncing the full blockchain
|
||||
* Start the `spee.ch-sync` tool available at [billbitt/spee.ch-sync](https://github.com/billbitt/spee.ch-sync)
|
||||
|
@ -74,7 +74,7 @@ Parameters:
|
|||
* `license` (optional)
|
||||
* `title` (optional)
|
||||
* `description` (optional)
|
||||
* `thumbnail` url to thumbnail image, for .mp4 uploads only (optional)
|
||||
* `thumbnail` URL to thumbnail image, for .mp4 uploads only (optional)
|
||||
* `channelName` channel to publish too (optional)
|
||||
* `channelPassword` password for channel to publish too (optional, but required if `channelName` is provided)
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Configure your own spee.ch
|
||||
|
||||
_note:this guide assumes you have done the []quickstart](https://github.com/lbryio/spee.ch/blob/readme-update/README.md) or [fullstart](https://github.com/lbryio/spee.ch/blob/readme-update/fullstart.md) guide and have a working spee.ch server_
|
||||
_note: this guide assumes you have done the []quickstart](https://github.com/lbryio/spee.ch/blob/readme-update/README.md) or [fullstart](https://github.com/lbryio/spee.ch/blob/readme-update/fullstart.md) guide and have a working spee.ch server_
|
||||
|
||||
## Custom Components
|
||||
The components used by spee.ch are taken from the `client/` folder, but you can override those components by defining your own in the `client_custom/` folder.
|
||||
|
|
Loading…
Reference in a new issue