Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vanvianen committed Aug 7, 2023
1 parent 61564db commit b3aa6c0
Showing 1 changed file with 38 additions and 17 deletions.
55 changes: 38 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
<div align="right">

[![license](https://img.shields.io/github/license/block-foundation/block.gl?color=green&label=license&style=flat-square)](LICENSE.md)
[![website](https://img.shields.io/website?color=blue&down_color=red&down_message=offline&label=website&style=flat-square&up_color=green&up_message=online&url=https%3A%2F%2Fwww.block.gl)](https://www.block.gl)
![stars](https://img.shields.io/github/stars/block-foundation/block.gl?color=blue&label=stars&style=flat-square)
![sponsors](https://img.shields.io/github/sponsors/geoid-org?color=blue&label=sponsors&style=flat-square)
![contributors](https://img.shields.io/github/contributors/block-foundation/block.gl?color=blue&label=contributors&style=flat-square)
[![GitHub License](https://img.shields.io/github/license/block-foundation/blocktxt?style=flat-square&logo=readthedocs&logoColor=FFFFFF&label=&labelColor=%23041B26&color=%23041B26&link=LICENSE)](https://github.com/block-foundation/block.gl/blob/main/LICENSE)
[![devContainer](https://img.shields.io/badge/Container-Remote?style=flat-square&logo=visualstudiocode&logoColor=%23FFFFFF&label=Remote&labelColor=%23041B26&color=%23041B26)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/block-foundation/block.gl)

</div>

Expand All @@ -18,9 +15,30 @@

---

## Introduction
<img align="right" width="75%" src="https://raw.githubusercontent.com/block-foundation/brand/master/src/image/repository_cover/block_foundation-structure-03-accent.jpg" alt="Block Foundation Brand">

### Contents

- [Introduction](#introduction)
- [Colophon](#colophon)

`block.gl` is a browser-native blockchain visualization library, designed to make the otherwise complex operations of a blockchain more accessible and comprehensible.
<br clear="both"/>

---

<div align="right">

[![Report a Bug](https://img.shields.io/badge/Report%20a%20Bug-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23E1E4E5)](https://github.com/block-foundation/block.gl/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=bug_report.yml)
[![Request a Feature](https://img.shields.io/badge/Request%20a%20Feature-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23E1E4E5)](https://github.com/block-foundation/block.gl/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=feature_request.yml)
[![Ask a Question](https://img.shields.io/badge/Ask%20a%20Question-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23E1E4E5)](https://github.com/block-foundation/block.gl/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=question.yml)
[![Make a Suggestion](https://img.shields.io/badge/Make%20a%20Suggestion-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23E1E4E5)](https://github.com/block-foundation/block.gl/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=suggestion.yml)
[![Start a Discussion](https://img.shields.io/badge/Start%20a%20Discussion-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23E1E4E5)](https://github.com/block-foundation/block.gl/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=discussion.yml)

</div>

**`block.gl` is a browser-native blockchain visualization library, designed to make the otherwise complex operations of a blockchain more accessible and comprehensible.**

## Introduction

`block.gl` is written in TypeScript and ties into the vis.gl ecosystem.

Expand All @@ -34,7 +52,6 @@ Built with TypeScript and tied into the vis.gl ecosystem, block.gl offers an imm

Regardless of your current knowledge or experience with blockchain, block.gl can guide you towards a deeper understanding of this innovative and increasingly important field. So, whether you're a developer seeking to incorporate blockchain technology into your project, or simply a curious learner, let block.gl lead you on your journey to blockchain mastery. Welcome to the future of learning blockchain – welcome to block.gl.


## Installation

### HTML Script Tag
Expand All @@ -54,7 +71,9 @@ npm i block.gl
- [Website](https://www.block.gl)
- [NPM](https://www.npmjs.com/package/block.gl)

## Development
---

## Colophon

### Authors

Expand All @@ -64,25 +83,27 @@ The Block Foundation mission is enabling architects to take back initiative and

website: [www.blockfoundation.io](https://www.blockfoundation.io "Block Foundation website")

### Contributing
### Development Resources

#### Contributing

We'd love for you to contribute and to make **`block.txt`** even better than it is today!
We'd love for you to contribute and to make this project even better than it is today!
Please refer to the [contribution guidelines](.github/CONTRIBUTING.md) for information.

## Legal Information
### Legal Information

### Copyright
#### Copyright

Copyright &copy; 2023 [Block Foundation](https://www.blockfoundation.io/ "Block Foundation website"). All Rights Reserved.
Copyright &copy; 2023 [Stichting Block Foundation](https://www.blockfoundation.io/ "Block Foundation website"). All Rights Reserved.

### License
#### License

Except as otherwise noted, the content in this repository is licensed under the
[Creative Commons Attribution 4.0 International (CC BY 4.0) License](https://creativecommons.org/licenses/by/4.0/), and
code samples are licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0).

Also see [LICENSE](https://github.com/block-foundation/community/blob/master/LICENSE) and [LICENSE-CODE](https://github.com/block-foundation/community/blob/master/LICENSE-CODE).
Also see [LICENSE](https://github.com/block-foundation/community/blob/master/src/LICENSE) and [LICENSE-CODE](https://github.com/block-foundation/community/blob/master/src/LICENSE-CODE).

### Disclaimer
#### 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.**

0 comments on commit b3aa6c0

Please sign in to comment.