Skip to content

Commit

Permalink
Merge pull request #43 from metabrainz/akshat/readme-update
Browse files Browse the repository at this point in the history
Update README.md to support all MeB projects
  • Loading branch information
akshaaatt authored Jan 23, 2022
2 parents 142c0e9 + c8fec97 commit 470cdb5
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 18 deletions.
57 changes: 39 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,43 @@
![cover](/cover.png)

# MusicBrainz Design System

The humble beginnings of a grand MusicBrainz redesign. 🎨
<h1 align="center">
<br>
<a href=""><img src="/cover.jpg" alt="MetaBrainz Design System"></a>
</h1>

<h4 align="center">MetaBrainz Design System</h4>
<p align="center">
<a href="#about">About</a> •
<a href="#contributing">Contributing</a> •
<a href="#issues">Issues</a> •
<a href="#support">Support</a> •
<a href="#guidelines">Guidelines</a>
</p>

---

## About

This design system is a living, breathing document that contains all of the building blocks (React components, colors, icons, layout, etc) of the MusicBrainz website. It aims to be single source of truth for developers and designers. Still a work in progress, always will be.

## Usage

We are working on the beta version, instructions for usage to be added soon.

## Quick Links
- [Design Guidelines](#)
- [Components](#)
- [Contributing Guidelines](#)

## Contribute
Work in Progress. Coming soon. We will keep you updated. :blush:
This design system is a living, breathing document that contains all of the building blocks (React components, colors, icons, layout, etc) of the MetaBrainz projects. It aims to be single source of truth for developers and designers. Still a work in progress, always will be.

## Contributing
Got **something interesting** you'd like to **ask or share**? Start a discussion at `#metabrainz` IRC channel on libera.chat.

## Issues
If you think you have found a bug, please report it on the [issue tracker](https://tickets.metabrainz.org/).
Also, we highly suggest you start a discussion on our [community forum](https://community.metabrainz.org/) for any design requests or discussions.

## Support

Reach out to the developers at one of the following places:

- MetaBrainz Community: https://community.metabrainz.org/
- Development IRC Channel: `#metabrainz`
- E-Mail: **support@metabrainz.org**

## Guidelines
- [Design Guidelines](https://github.com/metabrainz/design-system/blob/master/docs/design-guidelines.md)
- [Components](https://github.com/metabrainz/design-system/blob/master/docs/component-usage.md)
- [Contributing Guidelines](https://github.com/metabrainz/design-system/blob/master/docs/component-usage.md)

Binary file added cover.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed cover.png
Binary file not shown.

0 comments on commit 470cdb5

Please sign in to comment.