Skip to content

Commit 6fef6d2

Browse files
committed
Document
1 parent de69681 commit 6fef6d2

File tree

4 files changed

+46
-4
lines changed

4 files changed

+46
-4
lines changed

README.md

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,40 @@
1-
# Codestar Streams
1+
<p align="center">
2+
<img width="300px" src="/logo.png">
3+
</p>
24

3-
> Codestar Streams implements Codestar Streaming Platform Front-end
5+
<h1 align="center">Codestar Streams</h1>
6+
7+
<p align="center">Streaming Platform Demo</p>
8+
9+
<p align="center">
10+
<a aria-label="npm package" href="https://www.npmjs.com/package/streams-client">
11+
<img alt="" src="https://img.shields.io/npm/v/streams-client.svg">
12+
</a>
13+
14+
<a aria-label="travis build" href="https://travis-ci.org/code-star/streams">
15+
<img alt="" src="https://img.shields.io/travis/code-star/streams.svg?logo=travis">
16+
</a>
17+
18+
<a aria-label="downloads" href="http://npm-stat.com/charts.html?package=streams-client&from=2018-10-13">
19+
<img alt="" src="https://img.shields.io/npm/dm/streams-client.svg">
20+
</a>
21+
22+
<a aria-label="last commit" href="https://github.com/code-star/streams/commits/master">
23+
<img alt="" src="https://img.shields.io/github/last-commit/code-star/streams.svg">
24+
</a>
25+
26+
<a aria-label="contributors graph" href="https://github.com/code-star/streams/graphs/contributors">
27+
<img src="https://img.shields.io/github/contributors/code-star/streams.svg">
28+
</a>
29+
30+
<a aria-label="license" href="https://github.com/code-star/streams/blob/master/LICENSE">
31+
<img src="https://img.shields.io/github/license/code-star/streams.svg" alt="">
32+
</a>
33+
</p>
34+
35+
## Status
36+
37+
**⚠️ This project is a work in progress and is not ready for production use yet!**
438

539
## Server
640

@@ -9,5 +43,3 @@
943
## License
1044

1145
[MIT](./LICENSE) &copy; [CODE.STΛR](https://github.com/code-star)
12-
13-
[lerna]: https://github.com/lerna/lerna/

logo.jpg

58.9 KB
Loading

packages/client/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Codestar Streams Client
22

3+
[![travis build](https://img.shields.io/travis/code-star/streams.svg?style=flat-square)](https://travis-ci.org/code-star/streams)
4+
[![version](https://img.shields.io/npm/v/streams-client.svg?style=flat-square)](http://npm.im/streams-client)
5+
[![downloads](https://img.shields.io/npm/dm/streams-client.svg?style=flat-square)](http://npm-stat.com/charts.html?package=streams-client&from=2018-10-13)
6+
[![MIT License](https://img.shields.io/npm/l/streams-client.svg?style=flat-square)](http://opensource.org/licenses/MIT)
7+
38
> Codestar Streams Client implements a React Client
49
510
## Scripts

packages/server/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Codestar Streams Server
22

3+
[![travis build](https://img.shields.io/travis/code-star/streams.svg?style=flat-square)](https://travis-ci.org/code-star/streams)
4+
[![version](https://img.shields.io/npm/v/streams-client.svg?style=flat-square)](http://npm.im/streams-client)
5+
[![downloads](https://img.shields.io/npm/dm/streams-client.svg?style=flat-square)](http://npm-stat.com/charts.html?package=streams-client&from=2018-10-13)
6+
[![MIT License](https://img.shields.io/npm/l/streams-client.svg?style=flat-square)](http://opensource.org/licenses/MIT)
7+
38
> Codestar Streams Server implements an Express Server
49
510
## Scripts

0 commit comments

Comments
 (0)