docs: create README file

felipecesr · Oct 21, 2024 · 422e451 · 422e451
1 parent 1932dbd
commit 422e451
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,13 @@
+JS Monorepo
+============
+[![GitHub Stars](https://img.shields.io/github/stars/felipecesr/monorepo.svg)](https://github.com/felipecesr/monorepo/stargazers) [![GitHub Issues](https://img.shields.io/github/issues/felipecesr/monorepo.svg)](https://github.com/felipecesr/monorepo/issues) [![Current Version](https://img.shields.io/badge/version-1.0.0-green.svg)](https://github.com/felipecesr/monorepo)
+
+## ⚡️ Install dependencies
+
+[`yarn`](https://yarnpkg.com/) is the recommended package manager to use with this project. Please use it instead of npm.
+
+Install dependencies with yarn by running
+
+```sh
+yarn
+```