diff --git a/Docs/readme.md b/Docs/readme.md new file mode 100644 index 0000000..102a801 --- /dev/null +++ b/Docs/readme.md @@ -0,0 +1,98 @@ +## Requirements + +* You must serve valid JSON from `/.well-known/interverse` +* The header `access-control-allow-origin *` must also be [added](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS). + +# Interverse v0.1 + +Interverse is currently an open alpha. + +No breaking changes are anticipated + +**Links** +* All links must be absolute links +* Avoid leaving slashes `/` at the end + + +## Fields + +### version +*float* + +Current version is `0.1` +Clients may check for a version + +--- +### client +*url string* + +Interverse is designed to be decentralized. On the Web it may be handy to link the website's own client. + +--- +### name +*string* + +Any name you choose, this will appear in previews from other sites/clients. + +--- +### image +*url string* + +The image you wish to appear for previews. + +--- +### location +*url string* + +The url for your website + +--- +### resources +*resource object* + +This field is intended to feature content on your website. + +**resource object:** + +Fields: +* **label**: *string* The label for the resource +* **icon** *url string* The icon for the resource +* **location** *url string* The location of the resource +* **description** *string* the description of the resource + +--- +### connections +*list of urls* + +Connections are what makes interverse powerful. When you connect to someone else their link or preview appears. + +--- +### connection groups +*connection groups* + +``` +{ + "Group1":["https://example.com",..], + "Group2":... +} +``` + +a object where each property is the tag or label for the group for the list of connnection urls. + +Instead of a simple list you may prefer to group your connections by a tag or topic. + + + +--- +### contact +*list of contact objects* + +A contact object is a simple what/where object. + +`{"email":"you@your.website}` + +Any contact information you wish to share. + +--- + +If you have any questions don't hesitate to e-mail gabriel@libresolutions.network \ No newline at end of file diff --git a/readme.md b/readme.md index 78e0510..610ceed 100644 --- a/readme.md +++ b/readme.md @@ -3,6 +3,7 @@ [Try it out!](https://libresolutions.network/Interverse) ## An inter-connected web-of-trust that allows you to easily discover like-minded sites. Interverse aims to enable [small-tech](https://small-tech.org#small-tech-is). + That means * No complicated software to run (beyond an existing website) * No Cryptocurrency/NFT @@ -14,13 +15,14 @@ Clients should be able to easily be ported to TOR/Gemini/IPFS/ect ### Can I join? You don't need my permission! -Simply follow the steps and you're online! - -1) Grab the [example file](https://codeberg.org/gabe/Interverse/src/branch/main/interverse-example.json) -2) Modify it with your data -3) Serve that file from **your.website/.well-known/interverse** -4) Ensure that the webserver also adds the correct header: `access-control-allow-origin *` -5) Feel free to test your setup by visiting: +Simply follow these steps and you're online! + +1) Grab the [example file](https://codeberg.org/gabe/Interverse/src/branch/main/interverse-example.json) or you can grab the one from [the Libre Solutions Network](https://libresolutions.network/.well-known/interverse) +2) [Check out the docs](Docs/readme.md) +3) Modify it with your data +4) Serve that file from **your.website/.well-known/interverse** +5) Ensure that the webserver also adds the correct header: `access-control-allow-origin *` +6) Feel free to test your setup by visiting: https://libresolutions.network/Interverse?url=your.website ### How do I run the client myself?