README.md in pagelet_rails-0.1.3 vs README.md in pagelet_rails-0.1.4
- old
+ new
@@ -1,9 +1,11 @@
# PageletRails
[](https://badge.fury.io/rb/pagelet_rails)
+Warning: This gem is still in testing, so API might change.
+
## Why?
* Do you have pages with a lot of information?
* The pages where you need to get data from 5 or 10 different sources?
* What if one of them is slow?
@@ -142,10 +144,11 @@
Options for `remote`:
* `true`, `:ajax` - always render pagelet through ajax
* `:turbolinks` - same as `:ajax` but inline for turbolinks page visit
* `false` or missing - render inline
* `:stream` - (aka BigPipe) render placeholder and render full version at the end of html. See streaming for more info.
+* `:ssi` - render through [server side includes](https://en.wikipedia.org/wiki/Server_Side_Includes)
### params
Example
```erb
@@ -403,34 +406,19 @@
<%= pagelet :pagelets_current_time, remote: true, ajax_group: 'leftpanel' %>
```
There will be one request per group. Missing value is considered a separate group as well.
-## All possible advantages of this gem's approach
-
-This is a list of all advantages that would be made possible by using this gem's approach of abstraction and decomposition. Note: not all features are implemented yet.
-
-- Ability to use HTTP public cache for fragment caching
-- Easier fragment caching on the server
-- Batch Ajax requests
-- Custom loading placeholders
-- Progressive rendering of the page
-- Partial page updates
-- "Super smart caching"
-- Delay render below the fold
-- Simplified development and testing
-- Minimum DSL or new syntax
-- Asset dependencies
-- Parallel rendering
-- Take advantage of HTTP2 features
-
## Todo
* delay load of not visible pagelets (aka. below the fold)
* do not load pagelets which are not visible to the user until user scrolls down. For example like Youtube comments.
* high test coverage
* update actionpack-action_caching gem to support rails 5
+## Links
+
+- [Parallel rendering in Rails](http://antulik.com/posts/2016-10-02-parallel-rendering-in-rails.html)
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).