Browse Source

Update readme with docker hub link

Alex Myasoedov 7 years ago
parent
commit
0427681762
1 changed files with 23 additions and 8 deletions
  1. 23 8
      Readme.md

+ 23 - 8
Readme.md

@@ -1,18 +1,37 @@
 ## Hacker Slides
 
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/msoedov/hacker-slides/blob/master/LICENSE)
 [![Build Status](https://travis-ci.org/msoedov/hacker-slides.svg?branch=master)](https://travis-ci.org/msoedov/hacker-slides)
+[![](https://images.microbadger.com/badges/image/msoedov/hacker-slides:latest.svg)](https://microbadger.com/images/msoedov/hacker-slides "Hacker slides image")
 
 This repo is a reworked version of [Sandstorm Hacker Slides](https://github.com/jacksingleton/hacker-slides) which features easy set up run outside of Sandstorm and without vagrant-spk. Likewise you can publish and edit your previous markdown slides which is not supported in the original version.
 
-[Demo](https://murmuring-sierra-54081.herokuapp.com)
+
+#### Features:
+
+- Reach ui editor
+- Markdown markup
+- Live reload
+- Color schemes
+- Pdf print
+- [Demo version](https://murmuring-sierra-54081.herokuapp.com)
+- Tiny 10 Mb docker image
+
 
 | Edit mode | Published  |
-|:-------------:|:-------:|:-------:|
-|![1st](https://sc-cdn.scaleengine.net/i/520e2f4a8ca107b0263936507120027e.png)|![1st](https://sc-cdn.scaleengine.net/i/7ae0d31a40b0b9e7acc3f131754874cf.png)|
-|![2nd](https://sc-cdn.scaleengine.net/i/5acba66070e24f76bc7f20224adc611e.png)|![2nd](https://sc-cdn.scaleengine.net/i/fee3e1374cb13b1d8c292becb7f514ae.png)|
+| --- | --- | --- |
+| ![1st](https://sc-cdn.scaleengine.net/i/520e2f4a8ca107b0263936507120027e.png) | ![1st](https://sc-cdn.scaleengine.net/i/7ae0d31a40b0b9e7acc3f131754874cf.png) |
+|![2nd](https://sc-cdn.scaleengine.net/i/5acba66070e24f76bc7f20224adc611e.png) | ![2nd](https://sc-cdn.scaleengine.net/i/fee3e1374cb13b1d8c292becb7f514ae.png) |
 
 
+Run from docker image
+-----
+```shell
+docker run -it -p 8080:8080 -v $(pwd)/slides:/app/slides msoedov/hacker-slides
+```
 
+Build locally
+----
 To build and run it locally
 ```go
 go get
@@ -30,10 +49,6 @@ docker run -it -p 8080:8080  -v $(pwd)/slides:/app/slides msoedov/hacker-slides
 ```
 
 
-### Todos:
-- Docker image
-
-
 Getting Help
 ------------