dkam/calligraphy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Brandon Robins
2017-12-14 23:28:49 -06:00
parent dde85d453c
commit 5c06f06fe2
1 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -11,7 +11,7 @@ Calligraphy is a Web Distributed Authoring and Versioning (WebDAV) solution for
Add the following line to your Gemfile: Add the following line to your Gemfile:
```ruby ```ruby
gem 'calligraphy', :git => 'https://github.com/eanlain/calligraphy' gem 'calligraphy'
``` ```
Then run `bundle install` Then run `bundle install`
@@ -19,6 +19,7 @@ Then run `bundle install`
Next, set up a `calligraphy_resource` route in `config/routes.rb` with a `resource_class`. Next, set up a `calligraphy_resource` route in `config/routes.rb` with a `resource_class`.
```ruby ```ruby
# config/routes.rb
calligraphy_resource :webdav, resource_class: Calligraphy::FileResource calligraphy_resource :webdav, resource_class: Calligraphy::FileResource
``` ```
@@ -37,6 +38,14 @@ The above will create a route, `/webdav` that will be able to handle the followi
* `UNLOCK` * `UNLOCK`
The routes will also use the `Calligraphy::FileResource`, enabling Rails to carry out WebDAV actions on files. The routes will also use the `Calligraphy::FileResource`, enabling Rails to carry out WebDAV actions on files.
Additionally, when using the `FileResource` class the resource root path (the location you'd like to serve files from) with the `resource_root_path` key:
```ruby
# config/routes.rb
calligraphy_resource :webdav, resource_class: Calligraphy::FileResource, resource_root_path: '/home/webdav'
```
This will serve local files from `/home/webdav` on the server through the `/webdav` endpoint.
## Extensibility ## Extensibility