README.md in content_spinning-0.2.0 vs README.md in content_spinning-0.3.0
- old
+ new
@@ -6,11 +6,11 @@
## Example
```ruby
"Hi {there|you}! I'm {efficient|productive}.".spin
# or
-ContentSpinning.spin "Hi {there|you}! I'm {efficient|productive}."
+ContentSpinning.spin("Hi {there|you}! I'm {efficient|productive}.")
```
returns this array :
```ruby
@@ -24,9 +24,59 @@
## Install
```
gem install content_spinning
+```
+
+## Usage
+
+### All spins
+
+Calculating the number of possibilities:
+
+```ruby
+> ContentSpinning.new("Hi {there|you}! I'm {efficient|productive}.").count
+
+4
+```
+
+Generating:
+
+```ruby
+> ContentSpinning.new("Hi {there|you}! I'm {efficient|productive}.").spin
+
+[
+ "Hi there! I'm efficient.",
+ "Hi there! I'm productive.",
+ "Hi you! I'm efficient.",
+ "Hi you! I'm productive."
+]
+```
+
+Beware, spins being combinatory, generating all the spins could be quite long.
+
+### Partial spins
+
+There is no guaranty of unicity among the results returned (this is random).
+If you ask for a limit greater than the number of possibilities, this returns all the possibilities.
+
+```ruby
+> ContentSpinning.new("Hi {there|you}! I'm {efficient|productive}.").spin(limit: 2)
+
+[
+ "Hi there! I'm efficient.",
+ "Hi you! I'm productive."
+]
+
+> ContentSpinning.new("Hi {there|you}! I'm {efficient|productive}.").spin(limit: 500)
+
+[
+ "Hi there! I'm efficient.",
+ "Hi there! I'm productive.",
+ "Hi you! I'm efficient.",
+ "Hi you! I'm productive."
+]
```
## Todo
A few things to do :