Skip to content

Commit

Permalink
chore: updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Sayan751 committed Aug 27, 2022
1 parent 9ea74b8 commit 1ea65ce
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,10 @@
[![npm download](https://img.shields.io/npm/dt/@sparser/email-address-parser?label=npm%20download)](https://www.npmjs.com/package/@sparser/email-address-parser)
![build status](https://github.com/Sayan751/email-address-parser/workflows/build/badge.svg)

An [RFC 5322](https://tools.ietf.org/html/rfc5322), and [RFC 6532](https://tools.ietf.org/html/rfc6532) compliant email address parser made with [pest parser](https://github.com/pest-parser/pest).
An [RFC 5322](https://tools.ietf.org/html/rfc5322) (without [display name support](#out-of-scope)), and [RFC 6532](https://tools.ietf.org/html/rfc6532) compliant email address parser made with [pest parser](https://github.com/pest-parser/pest).
This repository contains a [rust crate](./rust-lib/README.md) as well as a wrapper [WebAssembly module](./npm-pkg/README.md).

### Out of scope

Note that this packages is only for parsing email addresses.
It does not support parsing email addresses with display name, such as the following: `John Doe <[email protected]>`.

0 comments on commit 1ea65ce

Please sign in to comment.