documentation + links optimization
parent
a16c9c87e6
commit
50b1fa78f6
@ -1,23 +0,0 @@
|
||||
function fetchback(url,cback){
|
||||
fetch(url).then((request)=>request.json()).then((data)=>cback(data));
|
||||
}
|
||||
|
||||
function interverse_data(url,cback){
|
||||
url = interverse_proxy+"/initial?url="+url
|
||||
fetch(url).then((response)=> {
|
||||
if (!response.ok){
|
||||
return {}
|
||||
}
|
||||
return response.json();
|
||||
}).then((data)=>cback(data))
|
||||
|
||||
}
|
||||
|
||||
// https://davidwalsh.name/query-string-javascript
|
||||
function getUrlParameter(name) {
|
||||
name = name.replace(/[\[]/, '\\[').replace(/[\]]/, '\\]');
|
||||
var regex = new RegExp('[\\?&]' + name + '=([^&#]*)');
|
||||
var results = regex.exec(location.search);
|
||||
return results === null ? '' : decodeURIComponent(results[1].replace(/\+/g, ' '));
|
||||
};
|
||||
|
||||
@ -0,0 +1,32 @@
|
||||
# Getting started
|
||||
|
||||
## Create your interverse file
|
||||
|
||||
This file is essentially your 'listing'.
|
||||
|
||||
1. Grab the [example file](../interverse-example.json) or modify the [Libre Solutions Network](https://libresolutions.network/.well-known/interverse) one.
|
||||
2. Make your changes, feel free to reference the [format](readme.md)
|
||||
3. Ensure that the file is formatted as valid [JSON](https://www.json.org/json-en.html).
|
||||
Any errors will fail completely.
|
||||
|
||||
## Getting online
|
||||
|
||||
### Option A (ideal)
|
||||
* 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).
|
||||
|
||||
### Option B (simple)
|
||||
* Serve valid JSON from either:
|
||||
|
||||
* `/.well-known/interverse`
|
||||
* `/interverse.json`
|
||||
|
||||
Omitting the CORS header means that the client needs to ask a server to load the data, this can have performance impacts.
|
||||
|
||||
## How do I see my listing?
|
||||
|
||||
Interverse is a fully-decentralized system. You can [setup your instance]() or preview yourself at `https://libresolutions.network/interverse?url={your.domain}`.
|
||||
|
||||
*Note: libresolutions.network uses a fairly long cache value when no results are returned.*
|
||||
If you want to see your changes reflected immediately, consider adding the CORS header.
|
||||
|
||||
@ -0,0 +1,17 @@
|
||||
# Running your own instance
|
||||
|
||||
The reference instance is running at [libresolutions.network](https://libresolutions.network/interverse)
|
||||
|
||||
If all your connections are adding the [CORS header](getting-started.md) all you need is to serve the content of [Client/index.html](../Client/index.html) from your page.
|
||||
|
||||
That file is written so that it can be easily pasted into an existing page, or used as a hugo shortcode.
|
||||
|
||||
|
||||
Known instances:
|
||||
|
||||
* [jamespearson.xyz](https://jamespearson.xyz/interverse/)
|
||||
|
||||
|
||||
## interverse-proxy
|
||||
|
||||
For compatibility with [Discover]() or for displaying previews of sites not serving the CORS header you'll want to setup
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 1.6 MiB |
Binary file not shown.
Loading…
Reference in New Issue