diff --git a/README.md b/README.md index 669de37..9e62bc9 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,19 @@ -# What is MyJekyllBlog? +# MyJekyllBlog -MyJekyllBlog is a project to provide a SaaS web interface to Jekyll backed with a CMS and web hosting infrastructure. +MyJekyllBlog is an all-in-one multi-user CMS and hosting platform for Jekyll blogs. + +Administrators can log into the web panel and configure hosted domains that users can host blogs under (i.e. hosted-blog.com). + +Users can log into the web panel and configure a blog on their own domain or a subdomain of the hosted domains (i.e. mycookingblog.hosted-blog.com). Once they have a blog, they can use the CMS features to create posts, upload media, and otherwise manage their blog. + +Whenever a user updates their blog, the blog is rebuilt and deployed the to webservers. Each update is a git commit, and a history panel allows users to restore their blog to any past state. + +MyJekyllBlog comes with a complete set of ansible roles to automate the installation. ## Meet The Servers +This table shows a brief overview of the server types and their relationships. Additional descriptions for each server type follows the table. + | Server | Description | Services | Talks To | | --------- | ------------------------------------ | ----------------- | --------------------- | | Panel | Runs customer-facing web interface | mjb.web, nginx | build, store |