From 58e84f06e66ea7260552edef305085f9ee76fa2f Mon Sep 17 00:00:00 2001 From: kim Date: Mon, 21 Aug 2023 18:04:46 +0200 Subject: [PATCH 1/2] docs: add readme --- .all-contributorsrc | 42 ++++++++++++++++++++++++++++++++++++++++++ README.md | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 76 insertions(+) create mode 100644 .all-contributorsrc create mode 100644 README.md diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 00000000..0c17ba9b --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,42 @@ +{ + "files": ["README.md"], + "imageSize": 100, + "commit": false, + "commitConvention": "angular", + "contributors": [ + { + "login": "pyphilia", + "name": "Kim Lan Phan Hoang", + "avatar_url": "https://avatars.githubusercontent.com/u/11229627?v=4", + "profile": "https://www.linkedin.com/in/kim-lan-phan-hoang-a457bb130", + "contributions": ["code"] + }, + { + "login": "dialexo", + "name": "Alexandre Chau", + "avatar_url": "https://avatars.githubusercontent.com/u/14943421?v=4", + "profile": "https://www.linkedin.com/in/chau-alexandre/", + "contributions": ["code"] + }, + { + "login": "spaenleh", + "name": "Basile Spaenlehauer", + "avatar_url": "https://avatars.githubusercontent.com/u/39373170?v=4", + "profile": "https://github.com/spaenleh", + "contributions": ["code"] + }, + { + "login": "morganridel", + "name": "Morgan Ridel", + "avatar_url": "https://avatars.githubusercontent.com/u/14032127?v=4", + "profile": "https://github.com/morganridel", + "contributions": ["code"] + } + ], + "contributorsPerLine": 7, + "skipCi": true, + "repoType": "github", + "repoHost": "https://github.com", + "projectName": "graasp-sdk", + "projectOwner": "graasp" +} diff --git a/README.md b/README.md new file mode 100644 index 00000000..7151d0fe --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# Graasp SDK + +[![Latest version published on NPM](https://img.shields.io/npm/v/@graasp/sdk?logo=npm)](https://www.npmjs.com/package/@graasp/sdk) +[![Latest version released on Github](https://img.shields.io/github/package-json/v/graasp/graasp-sdk?color=deepskyblue&logo=github)](https://github.com/graasp/graasp-sdk/releases/latest) +![NPM package downloads per month](https://img.shields.io/npm/dm/@graasp/sdk?color=green) +![example branch parameter](https://github.com/graasp/graasp-sdk/actions/workflows/test.yml/badge.svg?branch=main) +![typescript version](https://img.shields.io/github/package-json/dependency-version/graasp/graasp-sdk/dev/typescript) + +This repository contains all shared utils and types for the Graasp ecosystem. + +# Installation + +Run yarn to install the packages. + +```sh +yarn +``` + +# Testing + +```sh +yarn test +``` + +## Contributors + + + + + + + + + From 42c853da408ca1d4d67538a0e76fdc4ca5f7abd4 Mon Sep 17 00:00:00 2001 From: kim Date: Mon, 21 Aug 2023 18:05:47 +0200 Subject: [PATCH 2/2] refactor: remove initial list of contributors --- .all-contributorsrc | 31 +------------------------------ 1 file changed, 1 insertion(+), 30 deletions(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index 0c17ba9b..c2e74788 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -3,36 +3,7 @@ "imageSize": 100, "commit": false, "commitConvention": "angular", - "contributors": [ - { - "login": "pyphilia", - "name": "Kim Lan Phan Hoang", - "avatar_url": "https://avatars.githubusercontent.com/u/11229627?v=4", - "profile": "https://www.linkedin.com/in/kim-lan-phan-hoang-a457bb130", - "contributions": ["code"] - }, - { - "login": "dialexo", - "name": "Alexandre Chau", - "avatar_url": "https://avatars.githubusercontent.com/u/14943421?v=4", - "profile": "https://www.linkedin.com/in/chau-alexandre/", - "contributions": ["code"] - }, - { - "login": "spaenleh", - "name": "Basile Spaenlehauer", - "avatar_url": "https://avatars.githubusercontent.com/u/39373170?v=4", - "profile": "https://github.com/spaenleh", - "contributions": ["code"] - }, - { - "login": "morganridel", - "name": "Morgan Ridel", - "avatar_url": "https://avatars.githubusercontent.com/u/14032127?v=4", - "profile": "https://github.com/morganridel", - "contributions": ["code"] - } - ], + "contributors": [], "contributorsPerLine": 7, "skipCi": true, "repoType": "github",