Create README.md

This commit is contained in:
bumi 2019-01-16 16:30:35 +00:00 committed by GitHub
parent 73853a5ad9
commit 33db4a4092
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 34 additions and 0 deletions

34
README.md Normal file
View File

@ -0,0 +1,34 @@
# OpenAlias Web
This tool creates custom pages with payment details for any domain with [OpenAlias](https://openalias.org) entries.
It can be used as a tipping/donation page. No setup or signup is required. All details are gathered from the OpenAlias DNS entries.
## What is OpenAlias?
OpenAlias ([openalias.org](https://openalias.org)) is an open standard for simpler addresses for any crypto currencies. [Read more here](https://openalias.org)
At its most basic, OpenAlias is a TXT DNS record on a FQDN (fully qualified domain name).
By combining this with DNS-related technologies [it has] created an aliasing standard that is extensible for developers,
intuitive and familiar for users, and can interoperate with both centralised and decentralised domain systems.
## Example:
Here is the page for the entries from donate@getmonero.org:
[[openalias-web-host]/donate@getmonero.org](https://openalias-web.herokuapp.com/donate@getmonero.org)
## How to get your page
If you already have a domain with OpenAlias DNS entries you already have one: https://openalias-web.herokuapp.com/YOUR DOMAIN
If not, simply configure your DNS entries as described on [OpenAlias.org](https://openalias.org) (because of DNS propagation it might take a bit until your page is available)
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/bumi/openalias-web .
## License
The tool is as available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).