diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..4743f61 --- /dev/null +++ b/_config.yml @@ -0,0 +1,8 @@ +title: Slugtastic +description: A simple slug generator for Rails. +google_analytics: +show_downloads: true +theme: jekyll-theme-midnight + +gems: + - jekyll-mentions diff --git a/index.html b/index.html deleted file mode 100644 index 11970cc..0000000 --- a/index.html +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - - - - Slugtastic by danbee - - - - -
-
-

Slugtastic

-

A simple slug generator for Rails.

- -
- Download as .zip - Download as .tar.gz - View on GitHub -
-
-
- -
-
-

-Slugtastic

- -

Simple gem for autogenerating permalink style slugs for your ActiveRecord models.

- -

-Requirements

- -

It should work with Rails 3.0 but it hasn't been tested.

- -

-Installation

- -

Add this line to your application's Gemfile:

- -
gem 'slugtastic'
-
- -

And then execute:

- -
$ bundle
-
- -

Or install it yourself as:

- -
$ gem install slugtastic
-
- -

-Usage

- -

Usage is very simple. Just add the following to your model:

- -
has_slug :slug, :from => :title
-
- -

This will generate a slug string from the title atrribute and store it in the slug attribute unless the slug already contains a string. The slug is generated pre-validation so you can still use validates_presence_of :slug.

- -

There are no extra options at present.

- -

-Contributing

- -
    -
  1. Fork it
    2. -
  2. Create your feature branch (git checkout -b my-new-feature)
    3. -
  3. Commit your changes (git commit -am 'Added some feature')
    4. -
  4. Push to the branch (git push origin my-new-feature)
    5. -
  5. Create new Pull Request
    6. -
-
-
- - - - \ No newline at end of file diff --git a/index.md b/index.md new file mode 100644 index 0000000..5b22e14 --- /dev/null +++ b/index.md @@ -0,0 +1,42 @@ +# Slugtastic + +Simple gem for autogenerating permalink style slugs for your ActiveRecord models. + +## Requirements + +* Ruby 1.9.2 or 1.9.3 +* Rails 3.1 or higher. + +It should work with Rails 3.0 but it hasn't been tested. + +## Installation + +Add this line to your application's Gemfile: + + gem 'slugtastic' + +And then execute: + + $ bundle + +Or install it yourself as: + + $ gem install slugtastic + +## Usage + +Usage is very simple. Just add the following to your model: + + has_slug :slug, :from => :title + +This will generate a slug string from the title atrribute and store it in the slug attribute unless the slug already contains a string. The slug is generated pre-validation so you can still use `validates_presence_of :slug`. + +There are no extra options at present. + +## Contributing + +1. Fork it +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Added some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create new Pull Request diff --git a/javascripts/main.js b/javascripts/main.js deleted file mode 100644 index d8135d3..0000000 --- a/javascripts/main.js +++ /dev/null @@ -1 +0,0 @@ -console.log('This would be the main JS file.'); diff --git a/params.json b/params.json deleted file mode 100644 index 43d7dd0..0000000 --- a/params.json +++ /dev/null @@ -1 +0,0 @@ -{"name":"Slugtastic","tagline":"A simple slug generator for Rails.","body":"# Slugtastic\r\n\r\nSimple gem for autogenerating permalink style slugs for your ActiveRecord models.\r\n\r\n## Requirements\r\n\r\n* Ruby 1.9.2 or 1.9.3\r\n* Rails 3.1 or higher.\r\n\r\nIt should work with Rails 3.0 but it hasn't been tested.\r\n\r\n## Installation\r\n\r\nAdd this line to your application's Gemfile:\r\n\r\n gem 'slugtastic'\r\n\r\nAnd then execute:\r\n\r\n $ bundle\r\n\r\nOr install it yourself as:\r\n\r\n $ gem install slugtastic\r\n\r\n## Usage\r\n\r\nUsage is very simple. Just add the following to your model:\r\n\r\n has_slug :slug, :from => :title\r\n\r\nThis will generate a slug string from the title atrribute and store it in the slug attribute unless the slug already contains a string. The slug is generated pre-validation so you can still use `validates_presence_of :slug`.\r\n\r\nThere are no extra options at present.\r\n\r\n## Contributing\r\n\r\n1. Fork it\r\n2. Create your feature branch (`git checkout -b my-new-feature`)\r\n3. Commit your changes (`git commit -am 'Added some feature'`)\r\n4. Push to the branch (`git push origin my-new-feature`)\r\n5. Create new Pull Request\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file