Skip to content

Commit a6d7db4

Browse files
committed
Added a proper README
1 parent 698469d commit a6d7db4

File tree

2 files changed

+55
-5
lines changed

2 files changed

+55
-5
lines changed

README.md

+51-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,52 @@
11
# tanglesta.sh
2-
The Electron app implementing my project 'Tanglestash'
2+
The Electron app implementing my project [Tanglestash](https://github.com/loehnertz/Tanglestash)
3+
4+
5+
## Download
6+
7+
You can download the application directly from GitHub.
8+
It is available for Windows, macOS and Linux.
9+
Get the latest release v1.0.0 right **[here](https://github.com/loehnertz/tanglesta.sh/releases/tag/v1.0.0)**.
10+
11+
12+
## Usage
13+
14+
After starting the application you might first want to setup your node provider.
15+
This is pre-set to `localhost` which means that you would need to run
16+
[IRI](https://github.com/iotaledger/iri) (the node software) on your own computer.
17+
18+
A tutorial to setup a node can be found here:
19+
https://iota.readme.io/v1.2.0/docs/install-iri or http://iota.partners/
20+
21+
At least for retrieving you could also use a node providing service for the public from here: https://iota.dance/nodes
22+
23+
After setting everything up you can either start retrieving a file that
24+
was persisted in the past using its 'entry-hash' or persist a new file onto the tangle!
25+
26+
Here's an entry-hash to test the application. It's the logo of the app so you need to save it as a `.png` file. It's not encrypted.
27+
```
28+
JJSIJGGRUSBLBMWDVUHRCHRRCMWLB9ZKZPNUMNTRXEDNRRDSMRAURWHAVPCX9RGOXDBSKJSZERIRA9999
29+
```
30+
31+
32+
## Features
33+
34+
- Works on Windows, macOS and Linux
35+
- Persist any data onto the tangle of IOTA
36+
- Retrieve data that was persisted with this module beforehand
37+
- Optionally encrypt your data with a password (via AES)
38+
- Store a string or even a whole file without any prior conversion
39+
40+
41+
## Disclaimer
42+
43+
I know that both the retrieving and persisting to and from the tangle
44+
are painfully slow compared to a traditional HTTP connection.
45+
Keep in mind though that this project is more of a proof-of-concept
46+
rather than a finished product.
47+
48+
49+
License
50+
-------
51+
52+
[MIT](LICENSE)

package-lock.json

+4-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)