Skip to content

Commit aab4109

Browse files
Merge pull request #54 from p2plabsxyz/w3up-client
feat: integrate w3up-client
2 parents b01101a + f2c2b81 commit aab4109

19 files changed

+1648
-1848
lines changed

README.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,22 @@
1010
<img src="https://img.shields.io/badge/license-MIT-silver.svg?style=flat-square" alt="License">
1111
</div><br>
1212

13-
DScan is a decentralized storage and file sharing tool.
14-
DScan allows you to quickly upload files as well as folders to [IPFS](https://ipfs.io/) by using [web3.storage](https://web3.storage/about/) and receive a "decentralized QR code" with IPFS CID. Later you can customize and share the QR code or hosted gateway link with everyone for easy and decentralized file sharing. Because of web3.storage, the content can be accessed over IPFS without the user installing and setting up a local instance of Kubo.<br>
13+
DScan enables you to quickly upload files and folders to [IPFS](https://ipfs.tech/) using [web3.storage](https://web3.storage/), and provides a "decentralized QR code" containing the IPFS CID. This QR code can later be customized and shared with anyone for easy and decentralized file sharing. Users can visit [console.web3.storage](https://console.web3.storage/) and log in to manage their accounts.
1514

16-
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+
DScan, leveraging the [w3up-client](https://blog.web3.storage/posts/the-data-layer-is-here-with-the-new-web3-storage), incorporates [DIDs](https://www.w3.org/TR/did-core/) and [UCAN](https://ucan.xyz/) to establish a robust framework for decentralized authentication and authorization. The use of DIDs enhances security and promotes digital self-sovereignty, while UCAN facilitates permissioned access and the delegation of capabilities, enabling users to manage access to their content securely.
16+
17+
Thanks to web3.storage, the content can be accessed over IPFS without the user installing and setting up a local instance of Kubo.
18+
19+
<div align="center">
20+
<img src="https://github.com/p2plabsxyz/dscan/blob/main/demo.png" />
21+
</div>
1722

1823
## 💻 Extension
1924

2025
| <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/) |
2126
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2227
| [![Install from Chrome Store](https://ipfs.io/ipfs/QmU4Qm5YEKy5yHmdAgU2fD7PjZLgrYTUUbxTydqG2QK3TT)<br>![](https://img.shields.io/chrome-web-store/users/idpfgkgogjjgklefnkjdpghkifbjenap?label=Chrome%20Web%20Store%20users&style=social)](https://chrome.google.com/webstore/detail/dscan-decentralized-qr-co/idpfgkgogjjgklefnkjdpghkifbjenap) |
2328

24-
## 📺 Demo
25-
26-
<div align="center">
27-
<img src="https://github.com/p2plabsxyz/dscan/blob/main/demo.gif" />
28-
</div>
29-
30-
> In case of ⚠️ "504 Gateway Time-out" error, try again after some time. You can also use other [IPFS gateways](https://ipfs.github.io/public-gateway-checker/) with your CID.
31-
3229
## 🛠 Development
3330

3431
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.
@@ -39,12 +36,6 @@ The extension's development code is placed in `/src` folder. manifest.json is in
3936
npm install
4037
```
4138

42-
First, generate the web3.storage API key:
43-
44-
- Go to [web3.storage](https://web3.storage/) and Sign In.
45-
- Click on Accounts and select Create an API Token.
46-
- Copy the API Token and paste it in the input field.
47-
4839
2. After development of the extension, run the following command. This will create a `production` build.
4940

5041
```bash
@@ -57,7 +48,7 @@ npm run build
5748

5849
5. Select `Load unpacked extension` and open the `buidl` folder.
5950

60-
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/).
51+
For more information, read the [web3.storage docs](https://web3.storage/docs/).
6152

6253
## 💫 Achievements
6354

demo.gif

-5 MB
Binary file not shown.

demo.png

1.91 MB
Loading

0 commit comments

Comments
 (0)