Skip to content

Latest commit

 

History

History
131 lines (89 loc) · 5.64 KB

README.md

File metadata and controls

131 lines (89 loc) · 5.64 KB

Geoid Logo

space.txt

A well-known .txt file for spatial identification.



license website

stars forks downloads sponsors contributors


Table of Contents

About

space.txt is a proposed standard which allows spatially enabled websites and applications to communicate their location.

Quick Start

1. Create

1.1 Filename

Create a text file called space.txt. Always use lower-case formatting for the filename.

1.2 Encoding

Make sure that the space.txt file is UTF-8 encoded to avoid issues with special characters and multiple languages.

2. Place

2.1. well-known Directory

In principle, the space.txt file should be placed under the /.well-known/ path of your website. For example:

https://example.com/.well-known/space.txt

2.2. Root Directory

If the /.well-known/ directory cannot be used for technical reasons, or if you want to use a fallback option, the space.txt file can also be placed in the root directory of your website. For example:

https://example.com/space.txt

The space.txt file can be placed in both locations of a website at the same time. Hence, the final directory structure for your website could look like this:

example.com/
├── index.html
├── space.txt
└── .well-known
    └── space.txt

3. Link

3.1. Head

Place a reference to the file using a “help” tag to the <head> section of your website. For example:

<link type="text/plain" rel="help" href="https://example.com/space.txt"/>

3.2. Button

Embed a space.txt button to your site and link it to your space.txt file.

4. Serve

4.1. Internet Media Type

The space.txt file should have an Internet Media Type of text/plain.

4.2. Protocol

The space.txt file must be served over HTTPS.

Authors

space.txt is an open-source project by Geoid.

Geoid is a spatial operating system that covers our entire planet with an extended intelligent dimension. This self-organizing network bridges our virtual and physical environments and is formed by all the people of our planet and the information and communication technologies that connect them. Geoid functions as a nervous system that mediates the data we produce and use in our daily lives, adds value to interconnectivity and cherishes spontaneous connections between people and the places and things they love.

website: www.geoid.org

Contributing

We'd love for you to contribute and to make space.txt even better than it is today! Please refer to the contribution guidelines for information.

License

Except where otherwise noted, space.txt by Geoid is licensed under the terms of the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit https://creativecommons.org/licenses/by-sa/4.0/ or write to Creative Commons, 171 Second Street, Suite 300, San Francisco, CA 94105, USA.

Disclaimer

THIS SOFTWARE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.