Skip to content

Commit be7470c

Browse files
committed
added better, less generic readme.
1 parent f42388c commit be7470c

File tree

1 file changed

+116
-0
lines changed

1 file changed

+116
-0
lines changed

readme.md

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
# Refinery CMS
2+
3+
__An open source Ruby on Rails content management system for Rails 3.__
4+
5+
Refinery also supports Rails 2.x using the [Rails 2.x stable branch](http://github.com/resolve/refinerycms/tree/rails2-stable). More information at [http://refinerycms.com](http://refinerycms.com)
6+
7+
## Requirements
8+
9+
* [Bundler](http://gembundler.com)
10+
* [ImageMagick](http://www.imagemagick.org/script/install-source.php)
11+
12+
## How to
13+
14+
* __[Install Refinery CMS](http://refinerycms.com/download)__
15+
* [Update Refinery CMS to the latest stable version](http://refinerycms.com/guides/how-to-update-refinery-to-the-latest-stable-version)
16+
* [Install Refinery CMS on Heroku](http://refinerycms.com/guides/how-to-install-refinery-on-heroku)
17+
* [Run the Refinery CMS test suite](http://refinerycms.com/guides/how-to-test-refinery)
18+
* __[Contribute to Refinery CMS](http://refinerycms.com/guides/how-to-contribute-to-refinery-development)__
19+
* __[Donate to the Refinery CMS core team](http://pledgie.com/campaigns/8431)__
20+
21+
## Getting Started
22+
23+
If you're new to Refinery, start with this guide:
24+
25+
* __[Getting started with Refinery](http://refinerycms.com/guides/getting-started-with-refinery)__
26+
27+
## What's it good at?
28+
29+
__Refinery is great for sites where the client needs to be able to update their website themselves__ without being bombarded with anything too complicated.
30+
31+
Unlike other content managers, Refinery is truly __aimed at the end user__ making it easy for them to pick up and make changes themselves.
32+
33+
### For developers
34+
35+
* Easily customise the look to suit the business.
36+
* __[Extend with custom engines](https://github.com/resolve/refinerycms/blob/master/doc/engines.md#readme)__ to do anything Refinery doesn't do out of the box.
37+
* Sticks to __"the Rails way"__ as much as possible; we don't force you to learn new templating languages.
38+
* Uses [jQuery](http://jquery.com/) for fast and concise Javascript.
39+
40+
![Refinery Dashboard](http://refinerycms.com/system/images/0000/0576/dashboard.png)
41+
42+
Wanna see Refinery for yourself? [Try the demo](http://demo.refinerycms.com/refinery)
43+
44+
## Help and Documentation
45+
46+
* [Getting Started](http://refinerycms.com/guides/getting-started-with-refinery)
47+
* [Guides](http://refinerycms.com/guides)
48+
* [Google Group Discussion](http://group.refinerycms.org)
49+
* [IRC Channel](http://refinerycms.com/guides/how-to-get-help-with-refinery#irc-channel)
50+
* [GitHub repository](http://github.com/resolve/refinerycms)
51+
* [Developer/API documentation](http://api.refinerycms.org)
52+
* [Twitter Account](http://twitter.com/refinerycms)
53+
* Documentation about: [Pages](https://github.com/resolve/refinerycms/blob/master/doc/pages.md#readme), [Images](http://github.com/resolve/refinerycms/blob/master/doc/images.md#readme), [Files](http://github.com/resolve/refinerycms/blob/master/doc/resources.md#readme), [Inquiries](http://github.com/resolve/refinerycms-inquiries/blob/master/readme.md#readme), [Settings](http://github.com/resolve/refinerycms/blob/master/doc/settings.md#readme), [Dashboard](http://github.com/resolve/refinerycms/blob/master/doc/dashboard.md#readme), [Authentication & Users](http://github.com/resolve/refinerycms/blob/master/doc/authentication.md#readme), [Extending with Engines](http://github.com/resolve/refinerycms/blob/master/doc/engines.md#readme).
54+
55+
## Features
56+
57+
### [Pages](http://github.com/resolve/refinerycms/blob/master/doc/pages.md#readme)
58+
59+
* Easily edit and manage pages with a [WYSIWYG visual editor](http://www.wymeditor.org/).
60+
* Manage you site's structure.
61+
62+
### [Images](http://github.com/resolve/refinerycms/blob/master/doc/images.md#readme) & [Files](http://github.com/resolve/refinerycms/blob/master/doc/resources.md#readme)
63+
64+
* Easily upload and insert images.
65+
* Upload and link to resources such as PDF documents.
66+
* Uses the popular [Dragonfly](http://github.com/markevans/dragonfly).
67+
* Supports storage on Amazon S3.
68+
69+
### [Inquiries](http://github.com/resolve/refinerycms-inquiries/blob/master/readme.md#readme)
70+
71+
* Collect inquiries from a contact form.
72+
* Manage your inquiries and be notified when new ones come in.
73+
* Checks new inquiries for spam.
74+
75+
### [Settings](http://github.com/resolve/refinerycms/blob/master/doc/settings.md#readme)
76+
77+
* Manage the behaviour of Refinery
78+
* Easily integrate with [Google Analytics](https://www.google.com/analytics/)
79+
80+
### [Dashboard](http://github.com/resolve/refinerycms/blob/master/doc/dashboard.md#readme)
81+
82+
* Get an overview of what has been updated recently and see recent inquiries.
83+
84+
### [Authentication & Users](http://github.com/resolve/refinerycms/blob/master/doc/authentication.md#readme)
85+
86+
* Manage who can access Refinery.
87+
* Control which engines each user has access to.
88+
* Uses the popular [authlogic](http://github.com/binarylogic/authlogic).
89+
90+
### ...Want more? [Extend with Engines](http://github.com/resolve/refinerycms/blob/master/doc/engines.md#readme)
91+
92+
Extend Refinery easily by running the Refinery engine generator
93+
94+
rails generate refinery_engine
95+
96+
to get help on how to use that. Or read the full documentation on [writing engines for Refinery](http://github.com/resolve/refinerycms/blob/master/docengines.md#readme)
97+
98+
### Popular Engines
99+
100+
* [Blog](http://github.com/resolve/refinerycms-blog) - A simple blogging engine that supports posts, categories and comments (with moderation support if you choose to enable it)
101+
* [Portfolio](http://github.com/resolve/refinerycms-portfolio) - manage groups of images like an image gallery.
102+
* [News](http://github.com/resolve/refinerycms-news) - post and manage news items.
103+
104+
[Full engine list here](http://github.com/resolve/refinerycms/wiki/engines)
105+
106+
### Example Site Showcase
107+
108+
[List here (add your link when you're done)](http://github.com/resolve/refinerycms/wiki/Example-Site-Showcase)
109+
110+
## License
111+
112+
Refinery is released under the [MIT license](http://github.com/resolve/refinerycms/blob/master/license.md#readme) and is copyright (c) 2005-2011 [Resolve Digital](http://www.resolvedigital.com)
113+
114+
### Credits
115+
116+
Many of the icons used in Refinery CMS are from the wonderful [Silk library by Mark James](http://www.famfamfam.com/lab/icons/silk/).

0 commit comments

Comments
 (0)