From 6783231069fd5a4b5e721f47d4ec830880bf3b1e Mon Sep 17 00:00:00 2001 From: CCheukKa Date: Mon, 29 Jul 2024 11:19:31 +0800 Subject: [PATCH] chore: Update README.md with logo and shields --- README.md | 22 +++++++++++++++++++++- assets/logo-dark.svg | 1 + assets/logo-light.svg | 1 + 3 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 assets/logo-dark.svg create mode 100644 assets/logo-light.svg diff --git a/README.md b/README.md index 6449da3..01345cf 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,25 @@ # iGEM upload API -This is an API that interfaces with the [iGEM upload tool](https://uploads.igem.org) to allow automatic file management and organisation. The goal is to entirely replace the manual process of uploading files to the iGEM server, which is time-consuming and very user-unfriendly. + +
+ + + + + + + + + + +**An API that interfaces with the [iGEM upload tool](https://uploads.igem.org) to allow automatic file management and organisation.** +The goal is to entirely replace the manual process of uploading files to the iGEM server, which is time-consuming and very user-unfriendly. + +[![NPM Version](https://img.shields.io/npm/v/igem-upload-api?style=flat-square)](https://www.npmjs.org/package/igem-upload-api) +[![install size](https://img.shields.io/badge/dynamic/json?url=https://packagephobia.com/v2/api.json?p=igem-upload-api&query=$.install.pretty&label=install%20size&style=flat-square)](https://packagephobia.com/result?p=igem-upload-api) +[![npm bundle size](https://img.shields.io/bundlephobia/minzip/igem-upload-api?style=flat-square)](https://bundlephobia.com/package/igem-upload-api@latest) +[![npm downloads](https://img.shields.io/npm/d18m/igem-upload-api?style=flat-square)](https://npm-stat.com/charts.html?package=igem-upload-api) + +
> [!CAUTION] > The iGEM internal API is not officially supposed to be used by the public. This entire project is reverse-engineered from the [upload tool](https://uploads.igem.org) web app and may break at any time. Please use at your own discretion. diff --git a/assets/logo-dark.svg b/assets/logo-dark.svg new file mode 100644 index 0000000..a40579e --- /dev/null +++ b/assets/logo-dark.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/logo-light.svg b/assets/logo-light.svg new file mode 100644 index 0000000..035a265 --- /dev/null +++ b/assets/logo-light.svg @@ -0,0 +1 @@ + \ No newline at end of file