Skip to content

Commit 6b8b8c2

Browse files
authored
Create README.md
1 parent b870001 commit 6b8b8c2

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## mtsp-decoder
2+
3+
This is a Swift-based decoder for the `.mtsp` container, which is designed to be hosted alongside a website's `index.html`.
4+
For more information on `.mtsp`, visit [github.com/rafalkopiec/mtsp](https://github.com/rafalkopiec/mtsp).
5+
6+
### Usage:
7+
- Add `MTSPDecoder` as an SPM dependency.
8+
- Initialise the `Decoder` class in your data model.
9+
- Pass in a URL of a metaspace-supported website, such as [https://metaspace.rocks/mtsp](https://metaspace.rocks/mtsp).
10+
- You will get back an optional `Container` if the download and parsing of the file was successful.
11+
- The `Decoder` class has a published `containers` dictionary, and the parsed `Container` will be added to that on success.
12+
- Subscribing to the published dictionary is recommended.
13+
14+
This `MTSPDecoder` swift-package module is minimal, and is covered with unit tests.

0 commit comments

Comments
 (0)