From 4f354768b67d1514a7c361d4036ec4aa04fe18c4 Mon Sep 17 00:00:00 2001
From: Alex Auvolat <alex@adnab.me>
Date: Fri, 18 Nov 2022 12:54:56 +0100
Subject: [PATCH] Add documentation

---
 src/enc/mod.rs | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/src/enc/mod.rs b/src/enc/mod.rs
index d299d0e..dd963b9 100644
--- a/src/enc/mod.rs
+++ b/src/enc/mod.rs
@@ -1,4 +1,21 @@
 //! Functions to generate nettext representations of data structures
+//!
+//! Example:
+//!
+//! ```
+//! use nettext::enc::*;
+//!
+//! let nettext_encoding = list([
+//!     string("CALL").unwrap(),
+//!     string("myfunction").unwrap(),
+//!     dict([
+//!         ("a", string("hello").unwrap()),
+//!         ("b", string("world").unwrap()),
+//!         ("c", raw(b"{ a = 12, b = 42 }").unwrap()),
+//!         ("d", bytes_split(&((0..128u8).collect::<Vec<_>>()))),
+//!     ]),
+//! ]).unwrap().encode();
+//! ```
 
 use std::collections::HashMap;