diff --git a/README.md b/README.md index 6a2a85b..e261c62 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,32 @@ -== ReddiHackerHunt +# Reddit-Hackernews-ProductHunt Clone on Rails + +This is the `readme.md` for a Ruby on Rails application that mimics social news link sharing websites like HackerNews, ProductHunt, and Reddit. + +Obviously the styling is different but the base functionality exists. + +### Why? + +Because when i was learning to program, I wanted to play with code that had a familiar model and get some instant gratification. + +The problem with learning to code is the learning-curve. Shit is real and painful and i found that the best cure for the pain was cloning an app with features and tweaking until it broke and learning along the way. + +I think this is why wordpress is SO popular. Its stupid-easy to fire-up, and changes come with one-click package installs and tiny code changes. + + + +### Features + +- A visitor can view the list of items +- A visitor can view a single item and comment on it +- A visitor can register for an account +- A user can login and logout +- A user can submit a new item +- A user can like/unlike an item + + +### Deploy? + +[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy) + +### Changing the Code!!! -features: diff --git a/app.json b/app.json new file mode 100644 index 0000000..785bbcd --- /dev/null +++ b/app.json @@ -0,0 +1,7 @@ +{ + "name": "Reddit-Hackernews-ProductHunt Clone on Rails", + "description": "Ruby on Rails application that mimics social news link sharing websites like HackerNews, ProductHunt, and Reddit.", + "repository": "github.com:blairanderson/rails-hackernews-reddit-producthunt-clone", + "logo": "https://hackernews-rails-clone.herokuapp.com/rrhnclone.png", + "keywords": ["rails", "ruby-on-rails", "hackernews", "producthunt", "reddit"] +} diff --git a/public/rrhnclone.png b/public/rrhnclone.png new file mode 100644 index 0000000..e47781c Binary files /dev/null and b/public/rrhnclone.png differ