Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Manuel Canga committed Nov 25, 2018
1 parent 371483c commit 971a431
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# gist-it-php
An little app to embed files from a github repository like a gist
A little app to embed files from a github repository like a gist into your blog / website

## Usage

Expand All @@ -11,6 +11,19 @@ Take a github file url and prefix it with a link to your app domain and embed th

**$file** should follow the github repository pattern of `$user/$repository/raw/master/$path`

## Example


```
<script src='https://gist-it-php.trasweb.net/trasweb/Team/blob/develop/Team.php'></script>
```

## Install

1. Create a subdomain in your hosting
2. Save this code in that subdomain
3. Add script tags( see Example ) to your blog pages

## References

Based on [robertkrimen/gist-it](https://github.com/robertkrimen/gist-it) project

0 comments on commit 971a431

Please sign in to comment.