Initial import of rusticata-macros-3.1.0
Bug: 193833713
Change-Id: I8c64a1f7a387fb4162d80d201b1cfcd7172ed0f3
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6defe1e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,110 @@
+# rusticata-macros
+
+[](./LICENSE-MIT)
+[](./LICENSE-APACHE)
+[](https://travis-ci.org/rusticata/rusticata-macros)
+[](https://github.com/rusticata/rusticata-macros/actions)
+[](https://crates.io/crates/rusticata-macros)
+
+<!-- cargo-sync-readme start -->
+
+# Rusticata-macros
+
+Helper macros for the [rusticata](https://github.com/rusticata) project.
+
+This crate contains some additions to [nom](https://github.com/Geal/nom).
+
+For example, the `error_if!` macro allows to test a condition and return an error from the parser if the condition
+fails:
+
+```rust
+use rusticata_macros::error_if;
+let r : IResult<&[u8],()> = do_parse!(
+ s,
+ l: be_u8 >>
+ error_if!(l < 4, ErrorKind::Verify) >>
+ data: take!(l - 4) >>
+ (())
+ );
+```
+
+See the documentation for more details and examples.
+
+<!-- cargo-sync-readme end -->
+
+## Nom versions
+
+Different versions of this crate are available, depending on nom version.
+
+- `rusticata-macros` 0.3.x depends on nom 6
+- `rusticata-macros` 0.2.x depends on nom 5
+
+## Documentation
+
+Crate is documented, do running `cargo doc` will crate the offline documentation.
+
+Reference documentation can be found [here](https://docs.rs/rusticata-macros/)
+
+## Changes
+
+### 3.0.1
+
+- Add `be_var_u64` and `le_var_u64`
+
+### 3.0.0
+
+- Upgrade to nom 6
+
+### 2.1.0
+
+- Add common trait `Serialize` for structures serialization
+
+### 2.0.4
+
+- Add function version of most combinators
+
+### 2.0.3
+
+- Add macros `q` (quote) and `align32`
+
+### 2.0.2
+
+- Add `upgrade_error` and `upgrade_error_to`
+
+### 2.0.1
+
+- Add macro `custom_check`
+- Add macro `flat_take`
+
+### 2.0.0
+
+- Upgrade to nom 5
+- Debug types: use newtypes
+
+### 1.1.0
+
+- Add macro `newtype_enum`
+
+### 1.0.0
+
+- Upgrade to nom 4.0
+ - Warning: this is a breaking change!
+- Mark `parse_uint24` as deprecated
+
+## License
+
+Licensed under either of
+
+ * Apache License, Version 2.0
+ ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+ * MIT license
+ ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
+dual licensed as above, without any additional terms or conditions.
+
