From b70801fd26498de0c3f2e848324e66b0ce96e179 Mon Sep 17 00:00:00 2001 From: Marc Bouchenoire Date: Tue, 30 Nov 2021 11:03:27 +0100 Subject: [PATCH] Improve README --- .github/logo.svg | 1 + packages/symbolist/README.md | 16 ++++++++++++---- 2 files changed, 13 insertions(+), 4 deletions(-) create mode 100644 .github/logo.svg diff --git a/.github/logo.svg b/.github/logo.svg new file mode 100644 index 0000000..4188a1f --- /dev/null +++ b/.github/logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/packages/symbolist/README.md b/packages/symbolist/README.md index 1547f25..f261a13 100644 --- a/packages/symbolist/README.md +++ b/packages/symbolist/README.md @@ -1,10 +1,18 @@ -# symbolist +# Symbolist ๐Ÿ”ฃ ๏ธA collection of every symbol from SF Symbols. -[![build](https://github.com/bouchenoiremarc/symbolist/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/bouchenoiremarc/symbolist/actions/workflows/ci.yml) [![npm](https://img.shields.io/npm/v/symbolist?color=%230cf)](https://www.npmjs.com/package/symbolist) [![gzipped](https://img.shields.io/bundlephobia/minzip/symbolist?label=gzipped&color=%2385f)](https://www.npmjs.com/package/symbolist) [![license](https://img.shields.io/github/license/bouchenoiremarc/symbolist?color=%23e4b)](https://github.com/bouchenoiremarc/symbolist/blob/main/LICENSE) - -๐Ÿ”— Explore and preview symbols in the [playground](https://marcbouchenoire.com/projects/symbolist). +[![version](https://img.shields.io/badge/SF%20Symbols%203.1-message?color=%23e27)](https://developer.apple.com/sf-symbols/) +[![build](https://img.shields.io/github/workflow/status/bouchenoiremarc/symbolist/CI?color=%23e27)](https://github.com/bouchenoiremarc/symbolist/actions/workflows/ci.yml) +[![npm](https://img.shields.io/npm/v/symbolist?color=%23e27)](https://www.npmjs.com/package/symbolist) +[![size](https://img.shields.io/bundlephobia/minzip/symbolist?label=size&color=%23e27)](https://bundlephobia.com/package/symbolist) +[![coverage](https://img.shields.io/codecov/c/github/bouchenoiremarc/symbolist?color=%23e27)](https://codecov.io/gh/bouchenoiremarc/symbolist) +[![license](https://img.shields.io/github/license/bouchenoiremarc/symbolist?color=%23e27)](https://github.com/bouchenoiremarc/symbolist/blob/main/LICENSE) + +- [๐Ÿค– **Automated**](#automation): Authored and updated automatically +- ๐Ÿงช **Reliable**: Fully tested with [100% code coverage](https://codecov.io/gh/bouchenoiremarc/symbolist) +- ๐Ÿ“ฆ **Typed**: Written in [TypeScript](https://www.typescriptlang.org/) and includes definitions out-of-the-box +- ๐Ÿ’จ **Zero dependencies** ## Introduction