From 54bab0fd4d8aa943ea53995439bf6ce7b720aa43 Mon Sep 17 00:00:00 2001 From: Lucas Leclerc Date: Tue, 9 Jul 2024 14:12:57 +0200 Subject: [PATCH] [ADD] add .env.sample file and write the README --- .env.sample | 1 + README.md | 27 +++++++++++++-------------- 2 files changed, 14 insertions(+), 14 deletions(-) create mode 100644 .env.sample diff --git a/.env.sample b/.env.sample new file mode 100644 index 0000000..7e3b967 --- /dev/null +++ b/.env.sample @@ -0,0 +1 @@ +VITE_ALCHEMY_API_KEY= \ No newline at end of file diff --git a/README.md b/README.md index 338a864..a8cc307 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,25 @@ -> If you see this section, you've just created a repository using [PoC Innovation's Open-Source project template](https://github.com/PoCInnovation/open-source-project-template). Check the [getting started guide](./.github/getting-started.md). +# Pretty Metamask -# [PROJECT'S NAME] - -[Project's description] - -## How does it work? - -[Explain how this project is working] +Metamask but prettier in Vue.js ## Getting Started ### Installation -[Explain how to install all of the project's dependencies] +```bash +npm install +``` +create a .env file at the root of the project and add your Alchemy API key like in the .env.sample file ### Quickstart -[Explain how to run this project] +```bash +npm run dev +``` ### Usage -[Explain how to use this project] +Create or import a wallet, connect to it, and interact with the blockchain ## Get involved @@ -31,11 +30,11 @@ If you're interested in how the project is organized at a higher level, please c ## Our PoC team ❤️ Developers -| [
[Developer's name]](https://github.com/MrZalTy) | [
[Developer's name]](https://github.com/MrZalTy) | [
[Developer's name]](https://github.com/MrZalTy) -| :---: | :---: | :---: | +| [
[Lucas Leclerc]](https://github.com/Intermarch3) | [
[Sacha Dujardin]](https://github.com/Sacharbon) | [
[Grégor Sternat]](https://github.com/Bouboubz) | [
[Alexandre Timal]](https://github.com/alexandreTimal) +| :---: | :---: | :---: | :---: | Manager -| [
[Manager's name]](https://github.com/adrienfort) +| [
[Nathan Flattin]](https://github.com/Nfire2103) | :---: |