docs: add readme (#244)

.all-contributorsrc

@@ -0,0 +1,13 @@
+{
+  "files": ["README.md"],
+  "imageSize": 100,
+  "commit": false,
+  "commitConvention": "angular",
+  "contributors": [],
+  "contributorsPerLine": 7,
+  "skipCi": true,
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "projectName": "graasp-sdk",
+  "projectOwner": "graasp"
+}

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
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->