Skip to content

Commit

Permalink
Add support for trademark guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
PeterShaggyNoble committed Dec 6, 2023
1 parent 909e1ca commit f26ed39
Show file tree
Hide file tree
Showing 8 changed files with 2,413 additions and 992 deletions.
26 changes: 21 additions & 5 deletions .jsonschema.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
"$ref": "#/definitions/sourceUrl"
},
"guidelines": {
"description": "The brand guidelines",
"$ref": "#/definitions/url"
},
"description": "The brand and trademark guidelines",
"$ref": "#/definitions/guidelines"
},
"aliases": {
"description": "The aliases for the brand",
"type": "object",
Expand Down Expand Up @@ -636,8 +636,8 @@
"$ref": "#/definitions/url"
},
"guidelines": {
"description": "The brand guidelines, if different from the original",
"$ref": "#/definitions/url"
"description": "The brand and trademark guidelines, if different from the original",
"$ref": "#/definitions/guidelines"
}
},
"additionalProperties": false
Expand Down Expand Up @@ -686,6 +686,22 @@
"$ref": "#/definitions/url"
}
},
"guidelines": {
"$id": "#guidelines",
"type": "object",
"properties":
"branding": {
"description": "Link to the brand guidelines",
"$ref": "#/definitions/url"
},
"trademark": {
"description": "Link to the trademark usage guidelines",
"$ref": "#/definitions/url"
}
},
"minProperties": 1,

This comment has been minimized.

Copy link
@adamrusted

adamrusted Dec 7, 2023

Not sure if this is me misunderstanding the JSON Schema, but does minProperties mean that we must always have at least one property in this object? I would assume this is a moot point, given the guidelines object will be optional full stop?

This comment has been minimized.

Copy link
@PeterShaggyNoble

PeterShaggyNoble Dec 8, 2023

Author Owner

Yep, minProperties means that if the guidelines object is present then it must include at least one entry. The guidelines object itself, though, is still optional; required entries in our JSON are handled on line 8 of this file.

"additionalProperties": false
},
"url": {
"$id": "#url",
"description": "HTTPS-only URL for a source",
Expand Down
9 changes: 7 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,9 @@ Make sure the icon is added in alphabetical order. If you're in doubt, you can a
Additionally, each icon in the `_data/simple-icons.json` file may be given any of the following optional values:

* The `slug` must be used to specify the icon's file name in cases where a modifier has been added to it in order to resolve a clash with an existing icon's name.
* The `guidelines` may be used to specify the URL of the brand's guidelines/press kit/etc. This is useful if the SVG file was sourced from a different place, still if the SVG file was sourced from the guidelines, the URL should be duplicated here.
* The `guidelines` may be used to:
* specify the URL of the `branding` guidelines/press kit/etc. This is useful if the SVG file was sourced from a different place, still if the SVG file was sourced from the guidelines, the URL should be duplicated here.
* specify the URL of the `trademark` (usage) guidelines, if it is not the same as the above.
* The `license` may be used to specify the license under which the icon is available. This is an object with a `type` and `url`. The `type` should be an [SPDX License ID](https://spdx.org/licenses/) or `"custom"`, the `url` is optional unless the `type` is `"custom"`.

Here is the object of the fictional brand from before, but with all optional values, as an example:
Expand All @@ -291,7 +293,10 @@ Here is the object of the fictional brand from before, but with all optional val
"slug": "afictionalbrand_modifier",
"hex": "123456",
"source": "https://www.a-fictional-brand.org/logo",
"guidelines": "https://www.a-fictional-brand.org/brand-guidelines",
"guidelines": {
"branding": "https://www.a-fictional-brand.org/brand-guidelines",
"trademark": "https://www.a-fictional-brand.org/trademark-guidelines"
},
"license": {
"type": "CC0-1.0",
"url": "https://www.a-fictional-brand.org/logo/license"
Expand Down
12 changes: 12 additions & 0 deletions DISCLAIMER.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,23 @@ Simple Icons asks that its users read this disclaimer fully before including an

## Table of Contents

- [Overwiew](#overview)

This comment has been minimized.

Copy link
@adamrusted

adamrusted Dec 7, 2023

Overview - not overwiew ;)

- [Licenses, Copyrights & Trademarks](#licenses-copyrights--trademarks)
- [Brand Guidelines](#brand-guidelines)
- [Update of Brands](#update-of-brands)
- [Removal of Brands](#removal-of-brands)

## Overview

Simple Icons is a non-commercial, not-for-profit, open source project run by a small group of volunteer maintainers in their spare time. As such, the project and its maintainers have no working legal knowledge nor any legal representation to guide it in matters of copyright law or trademark law, nor to assist us in interpreting any legal documentation provided by companies covering the same.

However, to the best of the team's understanding, the _inclusion_ of icons in our library constitutes fair use of copyrighted material but that that does not extend to the _usage_ of our icons by third parties. Recognising our lack of legal knowledge, though, we will always take immediate action, without question, if [sent a request](#removal-of-brands) by any copyright or trademark holder or their legal representative, to remove an icon from our library.

We also do not make any representation to the users of our pacakage that the inclusion of an icon in our library grants them any permissions in relation to its usage and encourage all our users to ensure they read each brand's guidelines in detail and adhere to the requirements set forth in such documents, seeking permission for usage where applicable. To aid in this, we have taken steps to add support for including copyright/trademark (usage) guidelines, where available, in our icons' metadata along with our existing support for including branding guidelines, featuring both prominently with each icon's entry on our website.

> **Note**\
> The addition of trademark guidelines to Simple Icons is an ongoing project. Hence, the absence of guidelines for a particular icon does not imply that the usage of that icon is not subject to certain restrictions.
## Licenses, Copyrights & Trademarks

> **Note**\
Expand Down
Loading

0 comments on commit f26ed39

Please sign in to comment.