From 6ef1f3be9718f20c78cf08e646e4db694c37e7bb Mon Sep 17 00:00:00 2001 From: Otoniel Reyes Date: Mon, 23 Aug 2021 11:43:18 -0400 Subject: [PATCH] Added demo info, added todo list --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index aad4206..99bedbc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # Frontsite Create a site for your app. +## Demo +If you want to see, the final result after running this generator in a blank rails app, you can visit the [demo](https://github.com/kenliten/frontsite-demo) [here](https://frontsite-demo.herokuapp.com). + ## Installation Add this line to your application's Gemfile: @@ -25,8 +28,19 @@ Run the generator: $ bin/rails g frontsite:install ``` +## TODO +The project isn't complete yet. +Next, I'll implement these features: + - Default privacy policy page + - Default terms & condition page + - Default contact mailer + - Functional contact form + - Some default (custom) error pages + - Feed/Newsletter capabilities + - A complete test suite for the engine + ## Contributing -Contribution directions go here. +If you have some ideas or the time to create any of the items above, feel free to help here, using the [issues](https://github.com/kenliten/frontsite/issues) tool. Contributions are welcome. ## License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).