Skip to content
This repository
Browse code

Docs tweaks

  • Loading branch information...
commit 004d623b229622b2de1b59e285312b9412875c6e 1 parent 9174336
Norman Clarke authored August 15, 2011

Showing 2 changed files with 16 additions and 0 deletions. Show diff stats Hide diff stats

  1. 11  Changelog.md
  2. 5  README.md
11  Changelog.md
Source Rendered
@@ -6,8 +6,19 @@ suggestions, ideas and improvements to FriendlyId.
6 6
 * Table of Contents
7 7
 {:toc}
8 8
 
  9
+## 4.0.0 (NOT_RELEASED_YET)
  10
+
  11
+This is a complete rewrite of FriendlyId, and introduces a smaller, faster and
  12
+less ambitious codebase. The primary change is the relegation of external slugs
  13
+to an optional addon, and the adoption of what were formerly "cached slugs"
  14
+as the primary way of handling slugging.
  15
+
9 16
 ## 3.3.0 (NOT_RELEASED_YET)
10 17
 
  18
+This is a compatiblity branch and will be maintained for apps that can't
  19
+upgrade to 4.0. No new features are planned, only bugfixes. If you're creating
  20
+a new app, please use 4.x.
  21
+
11 22
 * Support for Active Record 2.3 dropped
12 23
 * Convert blank slugs to nil automatically ([Gabe da Silveira ](https://github.com/dasil003))
13 24
 * Compatibility with Active Record 3.1 ([Andrew White](https://github.com/pixeltrix))
5  README.md
Source Rendered
@@ -22,6 +22,11 @@ versioning, scoped slugs, reserved words, and custom slug generators.
22 22
 
23 23
 FriendlyId is compatible with Active Record **3.0** and **3.1**.
24 24
 
  25
+## Version 4.x
  26
+
  27
+FriendlyId 4.x introduces many changes incompatible with 3.x. If you're upgrading,
  28
+please read the docs to see what's new.
  29
+
25 30
 ## Rails Quickstart
26 31
 
27 32
     gem install friendly_id

0 notes on commit 004d623

Please sign in to comment.
Something went wrong with that request. Please try again.