Bitcoin Legality Map

Tracking the legality of bitcoin globally
Add/change country legality »

View Map · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Help us maintain an up-to-date database tracking each countries' recognition of Bitcoin: github_username, repo_name, twitter_handle, linkedin_username, email, email_client, project_title, project_description

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

How to contribute

1. Go to the countries directory

2. Each country is divided into a file named by its alpha-2 country code (two-letter country codes). Find the alpha-2 code for the country you want to edit

   US = United States
   SV = El Salvador
   CH = Switzerland
   etc...

   Here is the full list of countries and their alpha-2 codes

3. Once inside the file, make edits inside the paragraph tags

   <p>...</p>

   tags.

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

(back to top)

Legality tags

There are 3 types of legality tags.

1. Legal

2. Legal, banking ban

3. Illegal

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Alon Shvartsman - @twitter_handle

Project Link: https://github.com/alonshvartsman/bitcoin-legality

(back to top)

Acknowledgments

(back to top)