Skip to content

Commit

Permalink
Finish off the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jellybob committed Apr 15, 2011
1 parent 7984eab commit 3eecb09
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
13 changes: 12 additions & 1 deletion README.md
Expand Up @@ -19,7 +19,9 @@ That would be a legitimate question. Here are my reasons:

* I didn't like Thoughtbot's web interface. Most of my clients would have a fit if they had to use it.
* I don't it's worth spending up to $540/year for.
* I had a free day, and wanted to try out Redis in a real application.
* I had some free time, and wanted to try out Redis in a real application.

Currently the web interface needs some polish, but it does work.

## Making it Work ##

Expand All @@ -29,6 +31,9 @@ add one of the Redis to Go addons to your application, after which you should be
Once you do that you'll be able to access the web interface. Unless you've changed the defaults in config.ru the default
username and password is "admin", and "password". You should change the defaults.

You should probably also change the settings for where you're hosted, but that's not essential. If you don't change the
settings then the instructions you get for setting up a new project will wrong though.

To create your first project hit the big "New Project" button, and give it a name. You'll then be presented with some
instructions on setting up your application to use Copycat for it's copy. Once you've finished doing that, and some content
has been uplaoded, you'll be able to see it.
Expand All @@ -47,6 +52,12 @@ enough demand, but it makes the syntax in the views much cleaner).
If you want to contribute, fork this repository, and submit a pull request when you're done. I won't accept patches which don't
come with accompanying tests, but I am quite happy to help you write those tests if it's not something you're used to doing.

## Things to be Done ##

* Mark which phrases have been published in the web interface.
* Add some filtering to the web interface. Currently it just dumps the complete list on the screen at once.
* Allow publishing from the web interface.

## Licensing ##

Copycat is developed by Blank Pad Development (http://blankpad.net), and released under the MIT License. As stated earlier, I
Expand Down
2 changes: 1 addition & 1 deletion views/projects/show.haml
@@ -1,5 +1,5 @@
%h1= @project["name"]
%p Double click on a phrase to edit it.
%p Click on a phrase to edit it.

%dl
- @blurbs.sort.each do |key, value|
Expand Down

0 comments on commit 3eecb09

Please sign in to comment.