Update README.md
This commit is contained in:
parent
b5966f98b2
commit
9a73b85090
63
README.md
63
README.md
@ -1,15 +1,43 @@
|
|||||||

|
<!-- Header -->
|
||||||
|
<div id="top" align="center">
|
||||||
|
<br />
|
||||||
|
|
||||||
---
|
<!-- Logo -->
|
||||||
|
<img src="https://git.zakscode.com/repo-avatars/b497daaf22a214fe6d6cc35b8ec217cd22401b668dff93dcfcc7557bd8a46d96" alt="Logo" width="200" height="200">
|
||||||
|
|
||||||
A distributed video transcoder
|
<!-- Title -->
|
||||||
|
### Transmute
|
||||||
|
|
||||||
[](https://gitlab.zakscode.com/zakscode/transmute/transmute/-/releases)
|
<!-- Description -->
|
||||||
|
Distributed Video Transcoding
|
||||||
|
|
||||||
[](https://gitlab.zakscode.com/zakscode/transmute/common)
|
<!-- Repo badges -->
|
||||||
[](https://gitlab.zakscode.com/zakscode/transmute/client)
|
[](https://git.zakscode.com/ztimson/Transmute/tags)
|
||||||
[](https://gitlab.zakscode.com/zakscode/transmute/server)
|
[](https://git.zakscode.com/ztimson/Transmute/pulls)
|
||||||
[](https://gitlab.zakscode.com/zakscode/transmute/worker)
|
[](https://git.zakscode.com/ztimson/template/issues)
|
||||||
|
|
||||||
|
<!-- Links -->
|
||||||
|
---
|
||||||
|
<div>
|
||||||
|
<a href="https://git.zakscode.com/ztimson/Transmute/wiki" target="_blank">Documentation</a>
|
||||||
|
• <a href="https://git.zakscode.com/ztimson/Transmute/releases" target="_blank">Release Notes</a>
|
||||||
|
• <a href="https://git.zakscode.com/ztimson/Transmute/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
|
||||||
|
• <a href="https://git.zakscode.com/ztimson/Transmute/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
---
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
- [Transmute](#top)
|
||||||
|
- [About](#about)
|
||||||
|
- [Built With](#built-with)
|
||||||
|
- [Setup](#setup)
|
||||||
|
- [Production](#production)
|
||||||
|
- [Development](#development)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
|
## About
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@ -44,12 +72,16 @@ collect metadata. If this metadata doesn't match your settings or a healthcheck
|
|||||||
|
|
||||||
Once a worker is available, it will request a job from the server & complete it using FFmpeg.
|
Once a worker is available, it will request a job from the server & complete it using FFmpeg.
|
||||||
|
|
||||||
## Documentation
|
### Built With
|
||||||
- [Wiki Docs](https://gitlab.zakscode.com/zakscode/transmute/transmute/-/wikis/home)
|
[](https://angular.io/)
|
||||||
- [Release Notes](https://gitlab.zakscode.com/zakscode/transmute/transmute/-/releases)
|
[](https://getbootstrap.com)
|
||||||
- [Tickets & Issues](https://gitlab.zakscode.com/zakscode/transmute/transmute/-/issues)
|
[](https://docker.com/)
|
||||||
|
[](https://nodejs.org/)
|
||||||
|
[](https://en.wikipedia.org/wiki/Shell_script)
|
||||||
|
[](https://typescriptlang.org/)
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>
|
<summary>
|
||||||
<h3 style="display: inline">Production</h3>
|
<h3 style="display: inline">Production</h3>
|
||||||
@ -76,7 +108,7 @@ Once a worker is available, it will request a job from the server & complete it
|
|||||||
- [Git](https://git-scm.com/downloads)
|
- [Git](https://git-scm.com/downloads)
|
||||||
- [Node](https://nodejs.org/en/download)
|
- [Node](https://nodejs.org/en/download)
|
||||||
- [FFmpeg](https://ffmpeg.org/download.html)
|
- [FFmpeg](https://ffmpeg.org/download.html)
|
||||||
- *[Docker](https://www.docker.com/products/docker-desktop/) (Optional)*
|
- [Docker](https://www.docker.com/products/docker-desktop/)
|
||||||
|
|
||||||
#### Instructions
|
#### Instructions
|
||||||
1. Clone this project: `git clone `
|
1. Clone this project: `git clone `
|
||||||
@ -95,3 +127,8 @@ Once a worker is available, it will request a job from the server & complete it
|
|||||||
- Start worker: `cd ../worker && npm run start`
|
- Start worker: `cd ../worker && npm run start`
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
## License
|
||||||
|
Copyright © 2023 Zakary Timson | Available under MIT Licensing
|
||||||
|
|
||||||
|
See the [license](./LICENSE) for more information.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user