Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
docelic committed Nov 12, 2019
1 parent 90ff218 commit bbdd166
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
11 changes: 7 additions & 4 deletions README.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,18 @@ While the maildir format was created for email, it works well for arbitrary data

Add the following to your application's "shard.yml":

dependencies:
maildir:
github: docelic/maildir.cr
```
dependencies:
maildir:
github: crystallabs/maildir.cr
version 5.0.1
```

And run "shards install".

== Usage

Initialize a maildir and create a maildir directory structure in /tmp/maildir_test
Initialize a Maildir and create a Maildir directory structure in `/tmp/maildir_test`:

require "maildir"
maildir = Maildir.new("/tmp/maildir_test") # creates tmp, new, and cur dirs
Expand Down
4 changes: 1 addition & 3 deletions shard.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: maildir
version: 5.0.0
version: 5.0.1

authors:
- Davor Ocelic <[email protected]>
Expand All @@ -9,7 +9,5 @@ crystal: 0.31.1
license: MIT

development_dependencies:
specreporter-spec:
github: docelic/specreporter-spec
ameba:
github: veelenga/ameba
2 changes: 1 addition & 1 deletion src/version.cr
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
class Maildir
VERSION = "5.0.0"
VERSION = "5.0.1"
end

0 comments on commit bbdd166

Please sign in to comment.