README.md in simplec-0.1.2 vs README.md in simplec-0.2.0
- old
+ new
@@ -16,11 +16,12 @@
We hate dependencies, but postgres is just too good. We use it for search
and JSONB.
- imagemagick
- For image processing.
+ 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.
@@ -74,16 +75,10 @@
- simplec-events
## Usage
-1. Add to gemfile
-2. Mount engine
-3. Create pages and corresponding templates
-4. Build, generator, or use an auxilary gem for page admin.
-5. Let users loose.
-
'www' is considered the default subdomain.
'admin' subdomain is reserved for administration functions if you wish.
If you want to modify all pages you should edit ::Page < Simplec::Page, this
@@ -101,10 +96,12 @@
TODO override field types howto
TODO explain using uuids for keys + pgcrypto
+TODO explain how to augment model classes (example in `test/dummy/config/initializers/simplec.rb`)
+
### Steps
1. Install simplec in your Rails application.
See installation section.
@@ -243,12 +240,30 @@
See this page for a good cheat sheet: http://markevans.github.io/dragonfly/imagemagick
## Roadmap
-1. Finish example admin.
+1. TODOS:
+ - Embedded image id (integer -> uuid)
+
+ - Check doc view helpers
+
+ - Throw clear warning when creating a page without a type
+
+ - Document `lib/simplec/controller_extensions.rb`
+
+ - Document why _subdomain in subdomain form in admin.
+
+ - rails generate simplec:install
+ Install app/models/page.rb, app/models/page/
+ initializer if needed, with options documented
+
+ - rewrite beginning part of usage
+
+ - simplec_path/simplec_url caching
+
1. Installer `rails generater simplec:install`
1. Upgrade summernote from 0.8.2 to 0.8.6
1. Search
@@ -261,21 +276,9 @@
## 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.
-
-## TODO
-
-- Document `lib/simplec/controller_extensions.rb`
-
-- Document why _subdomain in subdomain form in admin.
-
-- rails generate simplec:install
- Install app/models/page.rb, app/models/page/
- initializer if needed, with options documented
-
-- simplec_path/simplec_url caching
## Running dummy application
1. Create simplec postgres user