From 0f8d892170238743d6f06dcaedb4057fca08988b Mon Sep 17 00:00:00 2001 From: Kelvin Wong Date: Fri, 4 Mar 2016 03:34:52 +0800 Subject: [PATCH] Added a README.md --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..83391cf --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +[Repository for hkatv.rip](http://github.com/netsgnut/hkatv.rip) + +## About + +This repository stores the deployed version of [this website](http://hkatv.rip/). + +Made with love by [@siuying](http://github.com/siuying) and [@netsgnut](http://github.com/netsgnut). + +## How to Deploy? + +Currently the website is hosted on [S3](http://aws.amazon.com/s3/) as a static website. One can copy all the files in `public/` to the root of the bucket and start rocking. + +Alternatively one can also use the deploy script. It is written in Ruby and assumes [Bundler](http://bundler.io/) and [Rake](https://github.com/ruby/rake) are properly installed and configured. + +The necessary dependencies are installed by: + +```bash +bundle install +``` + +Place a `credentials.json` file and put it aside on the same directory with this readme. It should contain `AccessKeyId` and `SecretAccessKey`. Make sure this credential has write permission on the bucket specified at the Rakefile. + +Uploading then is all about: + +```bash +rake deploy +``` + +# History + +(Some sentimental short paragraphs here... sometime maybe?) +