Skip to content

Commit

Permalink
Release 14 new icons and 3 updated icons and 10 removed icons and 3 r…
Browse files Browse the repository at this point in the history
…enamed icons (v12.0.0)

## New Icons

- Audiobookshelf (#10605) (@21st-centuryman)
- Awwwards (#10539) (@stefanobartoletti)
- Foundry Virtual Tabletop (#10575) (@adamrusted)
- FusionAuth (#10776) (@service-paradis)
- Homepage (#10452) (@21st-centuryman)
- Hugging Face (#9259) (@PratyushJayachandran)
- Kagi (#10976) (@uncenter)
- n8n (#10909) (@CodeShakingSheep)
- Posit (#10987) (@cwickham)
- React Bootstrap (#10921) (@CodeShakingSheep)
- Sartorius (#10967) (@CodeShakingSheep)
- UiPath (#10773) (@Mvlprem)
- unpkg (#10317) (@service-paradis)
- Zigbee2MQTT (#10212) (@PeterShaggyNoble)

## Updated Icons

- Adidas (#10982) (@jglamp)
- FastAPI (#10663) (@uncenter)
- RenovateBot (#10996) (@sisp)

## Removed Icons

- FITE (#10060) (@PeterShaggyNoble)
- Flattr (#10380) (@service-paradis)
- Google Bard (#10453) (@PeterShaggyNoble)
- Integromat (#10152) (@PeterShaggyNoble)
- Niantic (#10979) (@PratyushJayachandran)
- Nintendo Network (#10006) (@adamrusted)
- Rome (#10113) (@PeterShaggyNoble)
- Shotcut (#10043) (@PeterShaggyNoble)
- Skynet (#10504) (@kwypchlo)
- Twitter (#9748) (@adamrusted)

## Renamed Icons

- `Airbrake.io` to `Airbrake` (#10513) (@PeterShaggyNoble)
- `Amazon Web Services` to `Amazon Web Services` (#10391) (@readboy8)
- `RStudio` to `RStudio IDE` (#10999) (@adamrusted)

## SDK Changes

### URL_REGEX -> urlRegex()

The exported const `URL_REGEX` has been removed. Please use `urlRegex()` instead:

```javascript
import {urlRegex} from 'simple-icons/sdk';
const regex = await urlRegex();
```

### .jsonschema.json

Now `.jsonschema.json` file is bundled in our package.

For more details, please see: #10276.
  • Loading branch information
simple-icons[bot] committed May 26, 2024
2 parents 1b5de10 + 72a037b commit cffa080
Show file tree
Hide file tree
Showing 45 changed files with 269 additions and 161 deletions.
7 changes: 3 additions & 4 deletions .jsonschema.json
Original file line number Diff line number Diff line change
Expand Up @@ -599,9 +599,8 @@
"required": ["type", "url"],
"properties": {
"type": {
"description": "The license name or 'custom'",
"type": "string",
"enum": ["custom"]
"description": "Custom license type",
"const": "custom"
},
"url": {
"description": "The URL to the license text by the brand",
Expand All @@ -617,7 +616,7 @@
},
"duplicate": {
"$id": "#duplicate",
"description": "A \"dup\" brand",
"description": "A brand that uses the same icon",
"type": "object",
"required": ["title"],
"properties": {
Expand Down
1 change: 1 addition & 0 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@
!sdk.mjs
!sdk.js
!sdk.d.ts
!.jsonschema.json
30 changes: 25 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Simple Icons welcomes contributions and corrections. Before contributing, please
* [Assessing Popularity](#assessing-popularity)
* [Opening an Issue](#opening-an-issue)
* [Adding or Updating an Icon](#adding-or-updating-an-icon)
* [Requesting Permission](#requesting-permission)
* [Testing Package Locally](#testing-package-locally)
* [Using Docker](#using-docker)

Expand Down Expand Up @@ -93,9 +94,6 @@ To be considered popular enough to be within our scope, a brand must be in exist
1. The website's Similarweb rank in any one country is either:
- In the top 100, or,
- In the top 10k, _with_ a global rank of 1m or better.
1. The website's Similarweb global rank in any one category is either:
- In the top 50, or,
- In the top 5k, _with_ a global rank of 1m or better.
1. In cases where a brand does not have its own website the Similarweb rank of its parent company will be accepted _if_ the brand is that company's primary product.
1. Its packages meet one of the following minimum requirements:
- [npm](https://www.npmjs.com): 100k weekly downloads,
Expand Down Expand Up @@ -433,6 +431,28 @@ Once you've completed the previous steps, create a pull request to merge your ed

If you have an affiliation to the brand you contributing that allows you to speak on their behalf then please disclose that in your pull request as it can help speed up our research and review processes.

### Requesting Permission

If a brand's terms and conditions state that we need permission to include their brand, we will tag related issues and PRs with `permission required`. Anybody creating a PR for one of these icons is responsible (even if we discover permission requirements during PR review) for obtaining said permission.

If a contributor have been asked to obtain permission, they have 2 weeks to confirm they've reached out to the brand. If they do not confirm they have done this during that time, the PR will be closed.

If the contributor _has_ confirmed they've reached out to the brand, we will wait a maximum of 2 months for a response. If the response is an outright 'no' or is ambiguous, both the PR and issue will be closed, and the issue will marked as `will not add`. If the brand does not respond, we may close the PR or mark it as a draft, depending on whether the contributor is still actively pursuing a response. If the brand approves usage, the contributor should add the email response to the comments of the PR, and we will continue to merge the icon into the collection.

#### Example Email

```text
Dear [Brand Name],
I am contributing to the Simple Icons project on GitHub (https://github.com/simple-icons/simple-icons) and would like to add your brand's icon.
One of the maintainers has requested - as per your Terms and Conditions - that I reach out to formally obtain permission prior to accepting it into their collection.
Could you please let me know at your earliest convenience whether or not we are okay to include your brand's icon in the project?
Kind regards,
[Your name]
```

## Testing Package Locally

* Make sure you have [Node.js](https://nodejs.org/en/download/) installed. At least version `^12.20.0 || ^14.13.1 || >=16.0.0` is required.
Expand Down Expand Up @@ -461,14 +481,14 @@ A SDK is included in the `simple-icons/sdk` entrypoint of the npm package to mak
```typescript
import { getIconsData, type IconData } from 'simple-icons/sdk';

const iconsData: IconData[] = getIconsData();
const iconsData: Promise<IconData[]> = getIconsData();
```

```javascript
import { getIconsData } from 'simple-icons/sdk';

/* @typedef {import("./simple-icons/sdk").IconData} IconData */

/* @type {IconData[]} */
/* @type {Promise<IconData[]>} */
const iconsData = getIconsData();
```
55 changes: 26 additions & 29 deletions README.md

Large diffs are not rendered by default.

0 comments on commit cffa080

Please sign in to comment.