Skip to content

Commit 22e3100

Browse files
committed
documentation update (README.md)
1 parent d9c531b commit 22e3100

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,27 @@
22

33
[![Build Status](https://travis-ci.org/hellogustav/elixir_email_reply_parser.svg?branch=master)](https://travis-ci.org/hellogustav/elixir_email_reply_parser)
44

5-
An Elixir port of https://github.com/github/email_reply_parser
5+
Originally an Elixir port of https://github.com/github/email_reply_parser
66
as well as (especially) its port of https://github.com/zapier/email-reply-parser
77

8+
For retrieval of the last reply from email message text (body).
9+
810
## Installation
911

10-
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
11-
by adding `elixir_email_reply_parser` to your list of dependencies in `mix.exs`:
12+
The package can be installed by adding `elixir_email_reply_parser` to your list of dependencies in `mix.exs`:
1213

1314
```elixir
1415
def deps do
1516
[{:elixir_email_reply_parser, "~> 0.1.0"}]
1617
end
1718
```
1819

19-
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
20-
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
21-
be found at [https://hexdocs.pm/elixir_email_reply_parser](https://hexdocs.pm/elixir_email_reply_parser).
20+
Published version of the docs can be found at [https://hexdocs.pm/elixir_email_reply_parser](https://hexdocs.pm/elixir_email_reply_parser).
21+
22+
## Usage
23+
24+
```elixir
25+
iex> email_content = "Hi!\n\n How are you?\n__________\nFrom: Some Author\n\n Previous email"
26+
iex> ElixirEmailReplyParser.parse_reply(email_content)
27+
"Hi!\n\n How are you?"
28+
```

0 commit comments

Comments
 (0)