README.md in simplec-0.4.0 vs README.md in simplec-0.4.1

- old
+ new

@@ -1,32 +1,37 @@ # Simplec -### A CMS for developers, built by developers. +### A CMS that stays out of the way. -This gem handles all of the rote parts of a CMS, but gets out of the way for -everything else. In Rails it is easy to build things from scratch, but it is -a waste of resources to build again and again. This library is an attempt to -get all of the good parts of a CMS without the baggage of a CMS that takes -over the entire ecosystem. +This gem handles all of the rote parts of a CMS, but gets out of the way for everything else. +In Rails it is easy to build things from scratch, but it is a waste of resources +to build again and again. This library is an attempt to get all of the good +parts of a CMS without the baggage of a CMS that takes over the entire +ecosystem. + ## Dependencies + - rails >= 5.0.5 -- pg >= 0.21.0; postgres >= 9.5 + This probably can be lowered to older versions. - We hate dependencies, but postgres is just too good. We use it for search - and JSONB. +- pg >= 0.21.0; Postgres >= 9.5 -- imagemagick + We hate dependencies, but Postgres is just too good. We use it for search + and JSONB. If you think we could make this database agnostic, we are open + for contributions! - For image processing. Note there is a known vulnerability, please update - accordingly: https://imagetragick.com/ - - dragonfly - We still hate dependencies, but this is a necessity and the best option. + We still hate dependencies, but this is a necessity and one of the best + options. We might change it out for ActiveStorage. +- imagemagick + + For image processing. + ## Recommended Dependencies - summernote Used for editor fields. Source is included. @@ -42,23 +47,27 @@ **The recommended dependencies are only required for the admin portions of your application.** _Optionally, you can create a separate set of assets for only the admin via standard Rails methods. Or you could not include them and deal with the -fallout. ;-)_ +fallout. We are happy to accept pull requests! ;-)_ ## Features + - Pages with Templates - Subdomain support -- Use application models or assets in CMS pages - - Search (coming soon) +- Documents and Document Sets (local or S3/Google/etc) + +- Use application models or assets in CMS pages + ## Anti-Features + - User management - Permissions ## Proposed auxilary gems @@ -67,10 +76,13 @@ Database and file syncs between enviroments. - simplec-blog: Don't always need or want a blog bundled in. (You might have your own.) +- simplec-sections: Sections compose pages. Configure pages composed of Sections + rather than taking a page hook line and sinker. + - simplec-admin: Opinionated, prebuilt way of managing pages. Take it or leave it. Or don't mount it and generate scaffold controllers and views for basic functions. - simplec-events @@ -236,10 +248,12 @@ ## imagemagick Installation varies per operating system. Image magic is used by dragonfly for on the fly (then cached) image manipulation. +Note there is a known vulnerability, please update accordingly: https://imagetragick.com/ + See this page for a good cheat sheet: http://markevans.github.io/dragonfly/imagemagick ## Roadmap 1. TODOS: @@ -263,10 +277,16 @@ - rewrite beginning part of usage - utilize thread local variable for found subdomain in #subdomain + - page previews? + + - configure uuid or integer pk/fk + + - note about migration versions on old rails installs + 1. Sitemap 1. Installer `rails generater simplec:install` 1. Upgrade summernote from 0.8.2 to 0.8.6 @@ -277,10 +297,12 @@ 1. Optional Gems 1. Remove as many dependencies as possible. +1. github-markdown for markup? + ## Contributing 1. Use it and file create issues. Somethings are core, other things will be relegated to 3rd party extensions. 2. Pull requests are welcome. See rule #1. @@ -301,9 +323,14 @@ psql simplec_development -c "CREATE EXTENSION pgcrypto;" 3. Migrate database rake db:migrate + +4. Run the documentation server + + gem install yard + yard server -r --no-cache --no-save --verbose --debug --backtrace ## Contributors - Matt Smith, Near Apogee Consulting (www.nearapogee.com)