Skip to content

Commit 43c5687

Browse files
committed
Update and organize assets
- Organize assets into subdirectories - Include license info for external (third party) assets - Update README screenshots to match current UI - Add GftW x DEV hackathon badge and GftW Mid-Level Grantee image to README Signed-off-by: sharon-wang <[email protected]>
1 parent 1de14aa commit 43c5687

37 files changed

+658
-33
lines changed

LICENSE

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
Software (and associated documentation) in this project is licensed
22
under the MIT License, Copyright (c) 2020 Elliot Evans & Sharon Wang.
33

4-
Assets (i.e. images, graphics, artwork, etc.) in this project are by
5-
Elliot Evans & Sharon Wang, and are licensed under the Creative Commons
6-
Attribution 4.0 International Public License (CC BY 4.0).
4+
Assets (i.e. images, graphics, artwork, etc.) in this project, other
5+
than those found in the assets/external directory, are by Elliot Evans
6+
and Sharon Wang, and are licensed under the Creative Commons Attribution
7+
4.0 International Public License (CC BY 4.0).
78

8-
Licenses can be found below.
9+
Assets in the assets/external directory are assets from another source or
10+
repository, which may not have been created by Elliot Evans or Sharon Wang.
11+
Please refer to the per-asset/per-source license information in assets/external.
12+
13+
Licenses relevant to Akita can be found below.
914

1015
=============================================================================
1116
=============================================================================
@@ -38,8 +43,10 @@ SOFTWARE.
3843
Creative Commons Attribution 4.0 International Public License (CC BY 4.0)
3944
https://creativecommons.org/licenses/by/4.0/
4045

41-
Assets (i.e. images, graphics, artwork, etc.) by Elliot Evans & Sharon Wang
42-
are licensed under CC BY 4.0.
46+
Assets (i.e. images, graphics, artwork, etc.) in this project, other
47+
than those found in the assets/external directory, are by Elliot Evans
48+
and Sharon Wang, and are licensed under the Creative Commons Attribution
49+
4.0 International Public License (CC BY 4.0).
4350

4451
By exercising the Licensed Rights (defined below), You accept and agree
4552
to be bound by the terms and conditions of this Creative Commons

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,26 @@
33
# Akita
44

55
[![Software License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6-
[![Assets License: CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
6+
[![Assets by Akita License: CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
77

88
A browser extension that gives you insight into your engagement with [Web Monetization](https://webmonetization.org/).
99

1010
Akita presents your top visited monetized sites, how much time you’re spending on them, and how much you're contributing (or could contribute) to them.
1111

1212
We've built this for the [Grant for the Web x DEV hackathon](https://dev.to/devteam/announcing-the-grant-for-the-web-hackathon-on-dev-3kd1)! We're so thrilled to have received a Runner Up Award for this project 🎉 - [Winners Announcement](https://dev.to/devteam/announcing-the-grant-for-the-web-x-dev-hackathon-winners-1nl4).
1313

14-
Our license information can be found [here](docs/LicenseInfo.md) and our license/copyright notices can be found in [LICENSE](LICENSE).
14+
Our license information can be found [here](docs/LicenseInfo.md) and our license/copyright notices can be found in [LICENSE](LICENSE). Assets in the [assets/external](assets/external) directory are assets from another source or repository, which may not have been created by Akita contributors. Please refer to the per-asset/per-source license information in [assets/external](assets/external).
15+
16+
<table>
17+
<tr>
18+
<td align="center"><a href="https://dev.to/devteam/announcing-the-grant-for-the-web-x-dev-hackathon-winners-1nl4"><img src="assets/external/devcommunity/GFTWRunnerUp.png" alt="Grant for the Web x DEV Community Hackathon Runner Up Badge" width="120px"></a></td>
19+
<td><strong>Grant for the Web x DEV Community Hackathon Runner Up</strong> (June 2020)</td>
20+
</tr>
21+
<tr>
22+
<td align="center"><a href="https://www.grantfortheweb.org/blog/2020-mid-grantees"><img src="assets/external/grantfortheweb/mid-level-grantees.png" alt="Grant for the Web Mid Level Grantee Image" width="200px"></a></td>
23+
<td><strong>Grant for the Web Mid Level Grantee</strong> (October 2020)</td>
24+
</tr>
25+
</table>
1526

1627
---
1728

@@ -44,26 +55,26 @@ We'd love to have you be a part of Akita! Please feel free to open issues or cre
4455
### Akita Extension Icon
4556
The Akita extension icon changes depending on the site you are visiting. If the site has monetization enabled, then the Akita icon will look something like this:
4657

47-
<img src="assets/demo_mon.svg" alt="Monetization Enabled Akita Icon" height="100px">
58+
<img src="assets/tutorial/demo_mon.svg" alt="Monetization Enabled Akita Icon" height="100px">
4859

4960
Otherwise, if the site does not have monetization enabled, then the icon will appear as:
5061

51-
<img src="assets/demo_unmon.svg" alt="Monetization Not Enabled Akita Icon" height="100px">
62+
<img src="assets/tutorial/demo_unmon.svg" alt="Monetization Not Enabled Akita Icon" height="100px">
5263

5364
### Akita Main View
5465
Our browser extension helps you see the top monetized sites you visit and your engagement with Web Monetization at-a-glance.
5566

5667
Here's a screenshot of what Akita looks like if you're using a Web Monetization provider:
5768

58-
<img src="assets/documentation/mon_demo_screenshot1.png" alt="Monetization Enabled Akita Main View" height="450px"><img src="assets/documentation/mon_demo_screenshot2.png" alt="Monetization Enabled Akita Main View" height="450px">
69+
<img src="assets/documentation/mon_demo_screenshot_mainview.png" alt="Monetization Enabled Akita Main View" height="450px"><img src="assets/documentation/mon_demo_screenshot_hoverdetail.png" alt="Monetization Enabled Akita Main View" height="450px">
5970

6071
You'll likely have some monetized sites that you visit often, but don't really spend much time on. Maybe you'd like to give them a little more love and spend a bit more time there, so that additional payment can be streamed to them. Check out the 'These monetized sites could use ♥️' section!
6172

6273
<img src="assets/documentation/needslove_demo_screenshot.png" alt="Needs Love Hover" width="330px">
6374

6475
Here's a screenshot of what Akita looks like if you don't have a Web Monetization provider installed:
6576

66-
<img src="assets/documentation/nonmon_demo_screenshot1.png" alt="Monetization Not Enabled Akita Main View" height="450px"><img src="assets/documentation/nonmon_demo_screenshot2.png" alt="Monetization Not Enabled Akita Main View" height="450px">
77+
<img src="assets/documentation/nonmon_demo_screenshot_mainview.png" alt="Monetization Not Enabled Akita Main View" height="450px"><img src="assets/documentation/nonmon_demo_screenshot_hoverdetail.png" alt="Monetization Not Enabled Akita Main View" height="450px">
6778

6879
### Akita Demo Video
6980
Click to check out a video walkthrough of Akita:
-133 KB
Binary file not shown.
-116 KB
Binary file not shown.
Loading
Loading
-135 KB
Binary file not shown.
-113 KB
Binary file not shown.
Loading
Loading
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# DEV Community Assets
2+
3+
Assets in [this directory](.) are licensed by **DEV Community** via the
4+
[DEV Community Website](https://dev.to/).
5+
6+
The following list contains attribution information for any assets included in this directory:
7+
8+
## [GFTWRunnerUp.png](GFTWRunnerUp.png)
9+
- **Creator/Attribution Parties**: [DEV Community](https://dev.to/)
10+
- **Copyright**: © 2021 DEV Community
11+
- **License**: [DEV Community Trademarks and Logos Policy](https://dev.to/terms#dev-trademarks-and-logo-policy)
12+
- Permission from DEV Community has been granted to the Akita project to include this image in the [README.md](/README.md) file for the Akita repository.
13+
- A copy of this license is provided in the Akita repository [here](docs/licenses/DEV_COMMUNITY_TRADEMARKS_AND_LOGOS_POLICY).
14+
- **Link**: [https://dev.to/badge/grant-for-the-web-hackathon-runner-up](https://dev.to/badge/grant-for-the-web-hackathon-runner-up)
15+
- **Modifications**: We have not made any modifications to this asset.
37.2 KB
Loading
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Grant for the Web Assets
2+
3+
Assets in [this directory](.) are licensed by **Coil Technologies, Inc.** via the
4+
[Grant for the Web website](https://www.grantfortheweb.org/).
5+
6+
The following list contains attribution information for any assets included in this directory:
7+
8+
## [mid-level-grantees.png](mid-level-grantees.png)
9+
- **Creator/Attribution Parties**: [Coil Technologies Inc.](https://coil.com/), [Grant for the Web](https://www.grantfortheweb.org/)
10+
- **Copyright**: © 2021 Coil Technologies, Inc.
11+
- **License**: [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/)
12+
- A copy of this license is provided in the Akita repository [here](/docs/licenses/CREATIVE_COMMONS_ATTRIBUTION_4_LICENSE).
13+
- **Link**: [https://www.grantfortheweb.org/blog/2020-mid-grantees](https://www.grantfortheweb.org/blog/2020-mid-grantees)
14+
- **Modifications**: We have not made any modifications to this asset.
Loading
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Web Monetization Assets
2+
3+
Assets in [this directory](.) are licensed by **WebMonetization.org**/**Web Incubator Community Group** via the
4+
[Web Monetization GitHub Repository](https://github.com/WICG/webmonetization).
5+
6+
The following list contains attribution information for any assets included in this directory:
7+
8+
## [wm-icon-animated.svg](wm-icon-animated.svg)
9+
- **Creator/Attribution Parties**: [WebMonetization.org](https://webmonetization.org/), [Web Incubator Community Group](https://wicg.org/)
10+
- **Copyright**: © 2021 WebMonetization.org
11+
- **License**: [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
12+
- A copy of this license is provided in the Akita repository [here](/docs/licenses/APACHE_2_LICENSE).
13+
- **Link**: [https://github.com/WICG/webmonetization/blob/master/static/img/wm-icon-animated.svg](https://github.com/WICG/webmonetization/blob/master/static/img/wm-icon-animated.svg)
14+
- **Modifications**: We have not made any modifications to this asset.

assets/wm-icon-animated.svg renamed to assets/external/webmonetization/wm-icon-animated.svg

Lines changed: 15 additions & 0 deletions
Loading
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)