commit 3918c22b41be75c1fb5145f2a48c46b51f9e27ae Author: Gabriel Wilson Date: Tue Jan 25 23:28:06 2022 -0500 TODO: convert to markdown diff --git a/Client/index.html b/Client/index.html new file mode 100644 index 0000000..2956a42 --- /dev/null +++ b/Client/index.html @@ -0,0 +1,116 @@ + + + + + Interverse - Libre Solutions Network + + + + + + + + + + + + + + + + + + + +
+ +

Libre Solutions Network - Interverse Docs

+
+
+
+ +

+
+
+

Content:

+
+ +
+

Links

+
+ +
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/Client/interverse.js b/Client/interverse.js new file mode 100644 index 0000000..e69de29 diff --git a/Docs/index.html b/Docs/index.html new file mode 100644 index 0000000..cae811c --- /dev/null +++ b/Docs/index.html @@ -0,0 +1,234 @@ + + + + + + Libre Solutions Network + + + + + + + + + + + + + + +
+ +

Libre Solutions Network - Interverse - Documentation

+
+
+
+

What is the interverse?

+

+ Interverse is a web0 search engine powered by trust and relationships.
+ +

+

What are the Benefits?

+
    +
  • No databases / cryptocurrency required
    • +
  • Super scalable!
    • +
  • Inspired by Web0 / Fediverse
    • +
+

Can I get started?

+

You don't need my permission!
+ Simply follow the steps and you're online! +

    +
  1. Grab the example file
    2. +
  2. Modify it with your data
    3. +
  3. Serve that file from your.website/.well-known/interverse
    4. +
  4. Ensure that the webserver also adds the correct header: +
    access-control-allow-origin * +
    5. +
  5. Feel free to test your setup by visiting:
    + https://libresolutions.network/Interverse?url=your.website
    6. +
  6. If you need any help feel free to contact us below.
    7. + +
+

Widget

+

+ Work in progress. Simply a demonstration of what is possible. +

+ + +
+ +
+

Interverse v0.l

+

The interverse file is the gateway to creating an interconnected trust-based web.

+

The file is json formatted but is simply at /.well-known/interverse on your domain/subdomain.

+
Example file +

Structure

+

Interverse is designed to be extensible, other clients may impliment other features on top.

+ +

Fields

+

name

+

The name of your website (it can be your name, your brand or group)...ect

+ + + + + + + + + + + + +
MandatoryTypeCan be empty
YesStringNot enforced
+

location

+

This is the location of your website.

+ + + + + + + + + + + +
MandatoryTypeCan be empty
YesString (url)Yes
+

image

+

Whatever image you want to use to represent your website

+ + + + + + + + + + + +
MandatoryTypeCan be empty
YesString (url)Not enforced
+

+

connections

+ + + + + + + + + + + +
MandatoryTypeCan be empty
Yeslist (of urls)Yes
+ +

resources

+

+ This is intended to be for content on your website you speifically want to feature. +

+ + + + + + + + + + + +
MandatoryTypeCan be empty
YesList (resource objects)Yes
+

Object fields:

+
label
+

Title of the resource

+ +
icon
+

Absolute link to a icon for the resource

+ +
location
+

the location of the resource (url)

+ +
description
+

Describe the resource

+ + +

contact

+ + + + + + + + + + + +
MandatoryTypeCan be empty
NoList (contact)Yes
+

version

+ + + + + + + + + + + +
MandatoryTypeCan be empty
NoNot enforcedYes
+
+ +
+ + + + + + + \ No newline at end of file diff --git a/Docs/interverse-example.json b/Docs/interverse-example.json new file mode 100644 index 0000000..5c24768 --- /dev/null +++ b/Docs/interverse-example.json @@ -0,0 +1,23 @@ +{ + "version": 0.1, + "name": "My website", + "image":"https://my.website/logo.svg", + "location": "https://my.website", + "resources": [ + { + "label": "RSS Feed", + "icon": "/icons/rss.svg", + "location": "https://my.website.com/rss.xml", + "description": "Stay up to date!" + } + ], + "connections": [ + "https://libresolutions.network", + "https://retroedge.tech" + ], + "contact": { + "e-mail": "contact@https://my.website", + "matrix": "@me:https://my.website", + "fediverse": "@me@mastodon.social" + } + } \ No newline at end of file diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..b7c9d31 --- /dev/null +++ b/readme.md @@ -0,0 +1,2 @@ +Just getting started. +