Update README, gemspec, and bump version

This commit is contained in:
Brandon Robins
2017-11-21 01:05:46 -06:00
parent 74134e8209
commit b0275e379d
4 changed files with 81 additions and 46 deletions

View File

@@ -1 +1,64 @@
# calligraphy
# Calligraphy
Calligraphy is a Web Distributed Authoring and Versioning (WebDAV) solution for Rails that:
* Provides a framework for handling WebDAV requests (e.g. `PROPFIND`, `PROPPATCH`)
* Allows you to extend WedDAV functionality to any type of resource
* Passes 103/104 of the [Litmus](https://github.com/tolsen/litmus) tests (using `Calligraphy::FileResource`)
## Getting Started
Add the following line to your Gemfile:
```ruby
gem 'calligraphy'
```
Then run `bundle install`
Next, set up a `calligraphy_resource` route in `config/routes.rb` with a `resource_class`.
```ruby
calligraphy_resource :webdav, resource_class: Calligraphy::FileResource
```
The above will create a route, `/webdav` that will be able to handle the following HTTP request methods:
* `OPTIONS`
* `GET`
* `PUT`
* `DELETE`
* `COPY`
* `MOVE`
* `MKCOL`
* `PROPFIND`
* `PROPPATCH`
* `LOCK`
* `UNLOCK`
The routes will also use the `Calligraphy::FileResource`, enabling Rails to carry out WebDAV actions on files.
## Extensibility
The `Calligraphy::Resource` class exposes all the methods used in the various `Calligraphy::WebDavRequest` classes.
To create a custom resource, simply inherit from `Calligraphy::Resource` and redefine the public methods you'd like to customize.
For example, to create a `CalendarResource`:
```ruby
module Calligraphy
class CalendarResource < Resource
def propfind(nodes)
# custom implementation of propfind for CalendarResource
end
...
end
end
```
## License
Calligraphy is Copyright © 2017 Brandon Robins.
It is free software, and may be redistributed under the terms specified in the [LICENSE](/LICENSE) file.