Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
johnnymillergh committed Oct 20, 2020
1 parent 4e69455 commit f5f2c84
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 13 deletions.
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
Spring Boot Starter
</div>
</div>

[![GitHub release](https://img.shields.io/github/release/johnnymillergh/media-streaming.svg)](https://github.com/johnnymillergh/media-streaming/releases)
[![Build Status](https://travis-ci.com/johnnymillergh/media-streaming.svg?branch=master)](https://travis-ci.com/johnnymillergh/media-streaming)
![Maven Package](https://github.com/johnnymillergh/media-streaming/workflows/Maven%20Package/badge.svg?branch=master)
[![GitHub issues](https://img.shields.io/github/issues/johnnymillergh/media-streaming)](https://github.com/johnnymillergh/media-streaming/issues)
[![GitHub forks](https://img.shields.io/github/forks/johnnymillergh/media-streaming)](https://github.com/johnnymillergh/media-streaming/network)
[![GitHub stars](https://img.shields.io/github/stars/johnnymillergh/media-streaming)](https://github.com/johnnymillergh/media-streaming)
Expand All @@ -18,7 +18,7 @@

# Media Streaming

**Media Streaming**, a Spring Boot Starter project.
**Media Streaming**, a Spring Boot Starter project, which makes media streaming easier in your Spring Boot based project.

## Features

Expand All @@ -28,21 +28,23 @@ Here is the highlights of **Media Streaming**:

`org.springframework.boot:spring-boot-starter-parent` - [![Spring Boot](https://maven-badges.herokuapp.com/maven-central/org.springframework.boot/spring-boot-starter-parent/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.springframework.boot/spring-boot-starter-parent/)

2. Docker support.

6. API visualization. Enhanced Swagger API documentation.

7. Log compression.
2. Media streaming over HTTP. (Basic media streaming ability was completed, more and more features is coming soon)

8. Request log.
3.

9. Method Argument Validation Aspect.
## Installation

10. Docker container log persistence.
The easiest way is to install the library via its [Maven package](http://search.maven.org/#search|gav|1|g%3A"com.drewnoakes" AND a%3A"metadata-extractor").

11. Startup statistics.
```xml
<dependency>
<groupId>com.jmframework.boot</groupId>
<artifactId>media-streaming-spring-boot-starter</artifactId>
<version>1.0.1</version>
</dependency>
```

12. Customized startup banner.
Alternatively, download it from the [releases page](https://github.com/johnnymillergh/media-streaming/releases).

## Usage

Expand All @@ -52,7 +54,7 @@ Here is the highlights of **Media Streaming**:
$ git clone https://github.com/johnnymillergh/media-streaming.git
```

2. Build with newest Intellij IDEA.
2. Build with the newest IntelliJ IDEA.

3. Click the green triangle to Run.

Expand Down
23 changes: 23 additions & 0 deletions media-streaming-sample-app/src/main/resources/banner.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
${AnsiStyle.BOLD}${AnsiColor.BRIGHT_GREEN}
__
/|/| _ _/'_ ( _/_ _ _ _ ' _
/ |(-(//(/ __)// (-(///)//)(/
_/
__ _
( _ _ /_ /_|
__)(///)/)((- ( |/)/)
/ / /
${AnsiStyle.BOLD}Muscle MIS :: Powered by Spring Boot ::${spring-boot.formatted-version}
${AnsiColor.CYAN}Author: Johnny Miller (鍾俊), email: [email protected]
${AnsiStyle.NORMAL}${AnsiColor.MAGENTA}http://patorjk.com/software/taag/#p=display&f=Italic&t=Media%20Streaming%0ASample%20App
${AnsiColor.BRIGHT_BLACK}
-------------------------------------------Font Info-------------------------------------------
italic.flf Version 2
by: Bas Meijer [email protected] [email protected]
fixed by: Ryan Youck [email protected]

------------------------------------------Banner Info------------------------------------------
Banner generated by Text ASCII Art Generator.
A web app that lets you type in large ASCII Art text lettering.
This can create art you can put in your email signature, on your webpage, etc etc.
More at http://patorjk.com/software/taag/

0 comments on commit f5f2c84

Please sign in to comment.