diff --git a/.github/assets/demo.gif b/.github/assets/demo.gif new file mode 100644 index 0000000..bd3e0d0 Binary files /dev/null and b/.github/assets/demo.gif differ diff --git a/README.md b/README.md index fa2f75c..ea744d6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # 📖 Matuto [![by](https://img.shields.io/badge/by-Web3%20Philippines-7b3fe4.svg?longCache=true&style=flat-square)](https://web3philippines.org) -> **Note**: This project is still under development. Please wait for the official release. - [![maintainer](https://img.shields.io/badge/maintainer-OSS%20Philippines-blue.svg?logo=github&labelColor=181717&longCache=true&style=flat-square)](https://ossph.org) [![release](https://img.shields.io/github/release/web3phl/matuto.svg?logo=github&labelColor=181717&color=green&style=flat-square)](https://github.com/web3phl/matuto/releases) [![star](https://img.shields.io/github/stars/web3phl/matuto.svg?&logo=github&labelColor=181717&color=yellow&style=flat-square)](https://github.com/web3phl/matuto/stargazers) [![license](https://img.shields.io/github/license/web3phl/matuto.svg?&logo=github&labelColor=181717&style=flat-square)](https://github.com/web3phl/matuto/blob/main/license) ![screenshot](src/assets/screenshot.png) @@ -10,6 +8,10 @@ Matuto is a simple chromium-based browser extension that provides a glossary of It's a Filipino word which means "to learn". Which is the goal of this project, to help people learn more about web3, blockchain and cryptocurrencies. 💜💙📖 +## ⚡ Demo + +![demo](.github/assets/demo.gif) + ## 💻 Development 1. Install the packages: @@ -36,6 +38,16 @@ It's a Filipino word which means "to learn". Which is the goal of this project, Right now, some of the terms and definitions are taken from [Blocknative's Glossary](https://www.blocknative.com/glossary) with modifications. We'll add more terms and definitions in the future. Please consider contributing to this project. Thanks! 🙏✨ +## 🎯 Contributing + +Contributions are welcome, create a pull request to this repo and we will review your code. Please consider to submit your pull request to the `dev` branch. Thank you! + +Read the project's [contributing guide](./contributing.md) for more info. + +## 💬 Discussions + +For any questions, suggestions, ideas, or simply you want to share your experience in using this project, feel free to share and discuss it with the [community](https://github.com/web3phl/matuto/discussions)! + ## 🐛 Issues Please report any issues or bugs by [creating a new issue here](https://github.com/web3phl/matuto/issues/new/choose), also make sure you're reporting an issue that doesn't exist. Any help to improve the project would be appreciated. Thanks! 🙏✨ @@ -47,3 +59,13 @@ Read the project's [code of conduct](./code_of_conduct.md). ## 📃 License This project is licensed under [GNU General Public License v3](https://opensource.org/licenses/GPL-3.0). + +## 📝 Author + +This project is developed and maintained by [Web3 Philippines](https://web3philippines.org) and [Open Source Software Philippines](https://ossph.org) with the help of awesome [contributors](https://github.com/web3phl/matuto/graphs/contributors). + +[![contributors](https://contrib.rocks/image?repo=web3phl/matuto)](https://github.com/web3phl/matuto/graphs/contributors) + +--- + +Made 💻 with 💖 by [Web3 Philippines](https://web3philippines.org) and [Open Source Software Philippines](https://ossph.org) 💜💙 diff --git a/package.json b/package.json index 1614d18..363cdee 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,6 @@ "name": "matuto-extension", "version": "0.1.0", "description": "Simple and effective supplementary tool for learning Web3.", - "main": "src/manifest.json", "scripts": { "start": "parcel watch src/manifest.json --host localhost", "build": "parcel build src/manifest.json", diff --git a/src/assets/screenshot.png b/src/assets/screenshot.png index 93202ba..800db35 100644 Binary files a/src/assets/screenshot.png and b/src/assets/screenshot.png differ diff --git a/src/index.html b/src/index.html index 124d229..d74709e 100644 --- a/src/index.html +++ b/src/index.html @@ -34,7 +34,7 @@

Web3 Philippines

Photo from Unsplash

-

Community Partners:

+

Project Partners:

diff --git a/src/popup.html b/src/popup.html index d3789d8..f5385be 100644 --- a/src/popup.html +++ b/src/popup.html @@ -35,8 +35,9 @@ .img-wrapper > img { width: 50px; } - .sponsor { + .links { font-size: 14px; + text-align: center; } Matuto @@ -47,10 +48,14 @@
Matuto v0.1.0

By Web3 Philippines

-

Simple and effective supplementary tool for learning Web3. 💜💙💡

-