From 4da064796bd83412194df3e8908e12d48217a3fd Mon Sep 17 00:00:00 2001
From: James Smith <james@floppy.org.uk>
Date: Tue, 12 Nov 2024 21:52:57 +0000
Subject: [PATCH] add usage instructions

---
 README.md | 22 ++++++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 8359434..cc5031b 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,25 @@
 # Mittsu: 3MF
-3MF support for Mittsu
+3MF support for [Mittsu](https://github.com/danini-the-panini/mittsu).
 
+## Installation
 
-# About
+Just install:
+
+`bundle add mittsu-3mf`
+
+Then require in your code:
+
+`require 'mittsu/3mf'`
+
+## Usage
+
+Currently this gem just includes an exporter. Loading 3MF files is "coming soon".
+
+```
+exporter = Mittsu::ThreeMFExporter.new
+exporter.export(object, "output.3mf")
+```
+
+## About
 
 This code was originally written for [Manyfold](https://manyfold.app), supported by funding from [NLNet](https://nlnet.nl) and [NGI Zero](https://ngi.eu/ngi-projects/ngi-zero/).