|
1 | 1 | <p align="center">
|
2 |
| - <img align="center" src="/static/assets/logo.png" width="150" height"400"></img> |
| 2 | + <img align="center" src="/src/img/logo.png" width="150" height="150"></img> |
3 | 3 | </p>
|
4 | 4 |
|
5 | 5 | <h1 align="center">DScan</h1>
|
6 | 6 |
|
7 | 7 | <div align="center">
|
8 | 8 | <img src="https://img.shields.io/badge/extension-DScan-2C80C1" alt="Platform" />
|
9 | 9 | <img src="https://img.shields.io/github/v/release/akhileshthite/dscan?color=1FC71F" alt="Release version" />
|
10 |
| - <img src="https://img.shields.io/chrome-web-store/d/idpfgkgogjjgklefnkjdpghkifbjenap?label=active users" alt="Active users"> |
| 10 | + <img src="https://img.shields.io/badge/contributions-welcome-orange.svg?" alt="Contributions welcome"> |
11 | 11 | </div><br>
|
12 | 12 |
|
13 |
| -DScan allows you to quickly upload images, audio, video, and any type of files (including NFTs and static websites) to [IPFS](https://ipfs.io/) and get a QR code with IPFS links. Later you can share the QR code or [Infura](https://infura.io/) link with everyone for easy and decentralized file sharing. |
14 |
| -For more information you can read this [blog post](https://dev.to/akhileshthite/dscan-decentralized-qr-code-generator-use-web3-for-file-sharing-2lp8). If you have any queries, then follow this [discussion thread](https://github.com/filecoin-project/community/discussions/410). |
| 13 | +DScan allows you to quickly upload images, audio, video, and any type of files (including NFTs and static websites) to [IPFS](https://ipfs.io/) and get a decentralized QR code with IPFS links. Later you can share the QR code or hosted [Infura](https://infura.io/) link with everyone for easy and decentralized file sharing.<br> |
| 14 | +For more information, you can read this [blog post](https://dev.to/akhileshthite/dscan-decentralized-qr-code-generator-use-web3-for-file-sharing-2lp8). If you have any queries, then follow this [discussion thread](https://github.com/filecoin-project/community/discussions/410). |
15 | 15 |
|
16 |
| -### Add extension: |
17 |
| -* `Chromium browsers`: [Chrome web store](https://chrome.google.com/webstore/detail/dscan-decentralized-qr-co/idpfgkgogjjgklefnkjdpghkifbjenap) |
| 16 | +## Extension |
| 17 | +| <img src="https://unpkg.com/@browser-logos/chrome/chrome_16x16.png" width="16" height="16"> [Chrome](https://www.google.com/chrome/) \| <img src="https://unpkg.com/@browser-logos/brave/brave_16x16.png" width="16" height="16"> [Brave](https://brave.com/) \| <img src="https://unpkg.com/@browser-logos/opera/opera_16x16.png" width="16" height="16"> [Opera](https://www.opera.com/) \| <img src="https://unpkg.com/@browser-logos/edge/edge_16x16.png" width="16" height="16"> [Edge](https://www.microsoftedgeinsider.com/) | |
| 18 | +| ------------- | |
| 19 | +| [<br>](https://chrome.google.com/webstore/detail/dscan-decentralized-qr-co/idpfgkgogjjgklefnkjdpghkifbjenap) | |
18 | 20 |
|
19 |
| -### Development setup: |
20 | 21 |
|
21 |
| -* Download `extension.zip` from this github repository and extract it. |
| 22 | +## Development |
| 23 | +The extension's development code is placed in `/src` folder. manifest.json is in `/public` folder. For webpack settings, follow the `webpack.config.js` file. |
22 | 24 |
|
23 |
| -* Select `Developer mode` in your browser extensions. |
| 25 | +1. Install dependencies. |
24 | 26 |
|
25 |
| -* Select `Load unpacked extension` and open the extracted folder. |
| 27 | +```bash |
| 28 | +npm install |
| 29 | +``` |
26 | 30 |
|
27 |
| -### License |
28 |
| -DScan is licensed under the [MIT](https://github.com/AkhileshThite/dscan/blob/main/LICENSE) License. |
| 31 | +2. After development of the extension, run the following command. This will create a `production` build. |
| 32 | + |
| 33 | +```bash |
| 34 | +npm run build |
| 35 | +``` |
| 36 | + |
| 37 | +3. Now, the `buidl` will appear in the root directory. |
| 38 | + |
| 39 | +4. Select `Developer mode` in your browser extensions tab. |
| 40 | + |
| 41 | +5. Select `Load unpacked extension` and open the `buidl` folder. |
| 42 | + |
| 43 | +*After every change, run `npm run build` command and it will update `buidl` folder automatically, so you don't have to manualy upload the folder after every change.* |
| 44 | + |
| 45 | +For more information, read the [Webpack docs](https://webpack.js.org/concepts/) and the [Chrome Extension docs](https://developer.chrome.com/docs/extensions/mv3/getstarted/). |
| 46 | + |
| 47 | +## Contribute |
| 48 | +* Thanks for your interest in contributing to DScan. There are many ways you can contribute to the project. |
| 49 | +* To start, take a few minutes to read the [contribution guide](https://github.com/buidltools/dscan/blob/main/.github/CONTRIBUTING.md). |
| 50 | +* We look forward to your [pull requests](https://github.com/buidltools/dscan/pulls) and / or involvement in our [issues page](https://github.com/buidltools/dscan/issues). |
| 51 | + |
| 52 | + |
| 53 | +## License |
| 54 | +DScan is licensed under the [MIT License](https://github.com/buidltools/dscan/blob/main/LICENSE). |
| 55 | + |
| 56 | + |
| 57 | +<hr> |
| 58 | +Don't forget to leave a star ⭐️ ~ <a href="https://twitter.com/buidltools" target="_blank"><img src="https://img.shields.io/twitter/follow/buidltools?style=social" alt="twitter" /></a> |
29 | 59 |
|
30 |
| -### Support |
31 |
| -Don't forget to leave a star ⭐️. |
|
0 commit comments