Skip to content

geoid-org/blocktxt

 
 

Repository files navigation

Block Foundation Logo

block.txt

A well-known .txt file for blockchain addresses.



license website

stars forks downloads sponsors contributors


Table of Contents

About

...

Quick Start

1. Create

1.1 Filename

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

1.2 Encoding

Make sure that the block.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 block.txt file should be placed under the /.well-known/ path of your website. For example:

https://example.com/.well-known/block.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 block.txt file can also be placed in the root directory of your website. For example:

https://example.com/block.txt

The block.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
├── block.txt
└── .well-known
    └── block.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/block.txt"/>

3.2. Button

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

4. Serve

4.1. Internet Media Type

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

4.2. Protocol

The block.txt file must be served over HTTPS.

Authors

block.txt is an open-source project by the Block Foundation.

The Block Foundation mission is enabling architects to take back initiative and contribute in solving the mismatch in housing through blockchain technology. Therefore the Block Foundation seeks to unschackle the traditional constraints and construct middle ground between rent and the rigidity of traditional mortgages.

website: www.blockfoundation.io

Contributing

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

License

Except where otherwise noted, block.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.

About

A well-known .txt file for blockchain identification

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TeX 72.2%
  • Dockerfile 27.8%