Skip to content

Commit

Permalink
readme +
Browse files Browse the repository at this point in the history
  • Loading branch information
nuex committed May 27, 2010
1 parent e2c54eb commit 4b1ca05
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
@@ -0,0 +1,24 @@
= OVERVIEW

This extension is for a scenario where you want to use Radiant CMS but the web host does not have Ruby and only allows FTP access.

= INSTALL

git submodule add git://github.com/promptsite/radiant-static_sync-extension.git vendor/extensions/static_sync

= USAGE

Create a ftp.yml file in your 'config' directory similar to the following:

---
:host: remotesite.com
:user: myuser
:password: sup3rs3kr3t!
:root: /public_html

Run 'rake static:build' to build the static site and 'rake static:sync' to sync the static site with the remote FTP account. A 'rake static:build_and_sync' task is available to take care of both in one go.

= THANKS

The Radiant page to static file code is from jaknowlden's electrostatic extension: http://github.com/thumblemonks/radiant-electrocstatic-extension/.

6 changes: 6 additions & 0 deletions lib/tasks/static_sync_extension_tasks.rake
Expand Up @@ -10,6 +10,12 @@ namespace :static do
StaticSync.sync
end

desc "Build the static site and sync it with a remote ftp account"
task :build_and_sync => :environment do
Rake::Task['build'].invoke
Rake::Task['sync'].invoke
end

desc "Clean up any static_sync artifacts"
task :clean => :environment do
sh "rm -fr tmp/static"
Expand Down

0 comments on commit 4b1ca05

Please sign in to comment.