1 files changed, 23 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..da987ea
--- /dev/null
+++ b/README
@@ -0,0 +1,23 @@
+This app will autogenerate protobuf Sort() and Marshal() functions
+
+It was designed to work on .proto files designed with a standard
+way that utilizes this method:
+
+apple.proto should have
+
+message Apples {
+	string uuid
+	string version
+	repeaded Apple Apples
+}
+
+message Apple {
+	<whatever you want here>
+}
+
+This "scheme" as it were will be familar to others as a common way to pluralize data formats.
+In general, this is turning out to be a good way to handle protocol buffers for me so far.
+
+There are several things that can be put in the protobuf file to trigger what files are made.
+
+See the examples for how to do this.