initial commit

README.md

@@ -0,0 +1,60 @@
+# snac2nex
+
+[![Dependencies](https://deps.rs/repo/github/YGGverse/snac2nex/status.svg)](https://deps.rs/repo/github/YGGverse/snac2nex)
+[![crates.io](https://img.shields.io/crates/v/snac2nex.svg)](https://crates.io/crates/snac2nex)
+
+Export [Snac](https://codeberg.org/grunfink/snac2) profile to the [Nex](https://nightfall.city/nex/info/specification.txt) format.
+Useful as a mirroring tool for an existing fediverse instance or for migrating the data once.
+
+## Install
+
+``` bash
+cargo install snac2nex
+```
+
+## Usage
+
+``` bash
+snac2nex -s /path/to/snac/storage -t /path/to/nex -u user1 -u user2
+```
+
+### Options
+
+``` bash
+-s, --source <SOURCE>
+        Path to the Snac2 profile directory
+
+-t, --target <TARGET>
+        Target directory for public data export
+
+-u, --user <USER>
+        Username to export
+
+-r, --rotate <ROTATE>
+        Keep running as the daemon, renew every `n` seconds
+
+-f, --format-content <FORMAT_CONTENT>
+        Post template pattern
+
+        [default: {content}{attachments}{link}{tags}{updated}]
+
+    --format-filename <FORMAT_FILENAME>
+        Post filenames format
+
+        * escaped with `%%`
+
+        [default: %H:%M:%S.txt]
+
+    --format-updated <FORMAT_UPDATED>
+        Post `{updated}` time format
+
+        * escaped with `%%`
+
+        [default: "%Y/%m/%d %H:%M:%S"]
+
+-h, --help
+        Print help (see a summary with '-h')
+
+-V, --version
+        Print version
+```