aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index 12a306d..3de5ecc 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,8 @@
# Twittlet
+[![license](https://img.shields.io/badge/license-MIT_License_with_anime_exception-green.svg)](https://github.com/8cy/twittlet/blob/master/LICENSE)
+
+## Demo
+<img src="https://strelizia.cc/9p0uAzxmxqUrh4FaEAGpI4PdWrx7CgF7.gif" alt="demo" width="600px">
## What?
Got a little bored and realized that I want to eventually add a downloader service to my projects site which interacts with my Twitter bot. This is in a very early stage and at the moment its just a simple Twitter media API and downloader.
@@ -14,5 +18,16 @@ Will probably end up adding some of the few things down below.
- [ ] Add a method to get the size of the files (both dimensions and data size) and list that next to the links.
- [ ] Possible Bootstrap menu for cleaner look and tidy-ness.
+# Setup
+1. `$ npm install` to install dependencies.
+2. Do `$ node server.js` to start up the app. The default localhost URL should be `http://localhost:1337`.
+
### Also
`app.js` is just me testing to see if this package will even work. Way cleaner than the actual `server.js` codebase so if you are going to nab this, please nab that.
+
+### Links
+* [Website](https://kyzer.co/)
+* [GitHub](https://github.com/8cy/twittlet)
+
+### License
+MIT