Permalink
Browse files

Modified readme formatting, added explicit links, some text changes

  • Loading branch information...
1 parent 56c768d commit 62415fb527b4834b4c518695e7776ed9cf2e557c @awagener awagener committed with Jun 3, 2010
Showing with 29 additions and 36 deletions.
  1. +1 −14 .gitignore
  2. +28 −22 readme.md
View
15 .gitignore
@@ -1,26 +1,13 @@
public/system/*
-public/themes/*
log/*.log
tmp/**/*
.DS_Store
doc/api
doc/app
-doc/*
config/database.yml
-config/amazon_s3.yml
-config/rackspace_cloudfiles.yml
public/images/system/*
nbproject
index/**/*
db/*.sqlite3
*.tmproj
-*.autobackupbyrefinery.*
-refinerycms*.gem
-public/javascripts/cache
-public/stylesheets/cache
-config/database.yml.example
-.yardoc/
-refinerycms.gemspec
-.bundle
-vendor/cache
-*.lock
+*.autobackupbyrefinery.*
View
50 readme.md
@@ -1,8 +1,8 @@
-RefineryCMS-Blog
-================
+# RefineryCMS Blog
-Description:
-------------
+__A blog plugin for the [Refinery](http://github.com/resolve/refinerycms) content management system.__
+
+## Description:
Blog post with
@@ -15,22 +15,30 @@ Blog post with
Blog comments with
* Title, name, email, body
-* By default, Confirmable by Email
+* Email confirmation by comment author
* Optional Captcha
-* Optional Manual Moderation
-* Optional Email Notification
+* Optional manual moderation
+* Optional email notification
Administration panel
* write blogs
-* manage comments (unread/approved/refuse)
+* manage comments (unread/approved/refused)
* Change settings
-Dependencies
-------------
-Tags
-----
-You need to install http://github.com/mbleigh/acts-as-taggable-on
+## Dependencies
+
+RefineryCMS blog's gem requirements are:
+
+* [acts-as-taggable-on](http://github.com/mbleigh/acts-as-taggable-on)
+* [fattr](http://github.com/ahoward/fattr)
+* [rMagick](http://rubygems.org/gems/rmagick) (a Refinery dependency; this should be already installed)
+
+Instructions for installing these gems follows below.
+
+### Tags
+
+You need to install [http://github.com/mbleigh/acts-as-taggable-on](http://github.com/mbleigh/acts-as-taggable-on)
> gem install acts-as-taggable-on
@@ -44,11 +52,10 @@ to your Gemfile
If you are already using acts-as-taggable-on in your app, you may want to remove the migration file for "tags/taggings" tables.
-Captcha
--------
+### Captcha
-The Captcha use Raptcha, a really cool "one file lib" that just work from ahoward @ http://github.com/ahoward/raptcha
-If you want to use Captcha, you need rMagick (which is already a dependency of RefineryCMS) and fattr:
+The Captcha use Raptcha, a really cool "one file lib" that just work from ahoward @ [http://github.com/ahoward/raptcha](http://github.com/ahoward/raptcha)
+If you want to use Captcha, you need [rMagick](http://rubygems.org/gems/rmagick) (which is already a dependency of RefineryCMS) and [fattr](http://github.com/ahoward/fattr):
> gem install fattr
@@ -62,8 +69,7 @@ to your Gemfile
_The lib is located at /lib/raptcha.rb, you can update it or edit to fit your need._
-Installation (as a plugin)
---------------------------
+## Installation (as a plugin)
First, make sure you've run the migration on RefineryCMS (db:setup / db:migrate).
@@ -81,6 +87,6 @@ Copy the migration with
> rake db:migrate
-Credit
-------
-This is somewhat news plugin from Philip Arndt + comments. see: http://github.com/resolve/refinerycms-news
+## Credit
+
+This is somewhat news plugin from Philip Arndt + comments. see: [http://github.com/resolve/refinerycms-news](http://github.com/resolve/refinerycms-news)

0 comments on commit 62415fb

Please sign in to comment.