From 6329793b7488813ef81c7a9c3d6122c45bac4477 Mon Sep 17 00:00:00 2001 From: luigi-borriello00 Date: Mon, 4 Sep 2023 19:16:45 +0200 Subject: [PATCH] feat(readme): finish last sections --- README.md | 72 +++++++++---------------------------------------------- 1 file changed, 11 insertions(+), 61 deletions(-) diff --git a/README.md b/README.md index 50172b9b..46b1497a 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,6 @@ - - ## Getting Started -This is an example of how you may give instructions on setting up your project locally. -To get a local copy up and running follow these simple example steps. - -### Prerequisites - -This is an example of how to list things you need to use the software and how to install them. - -- npm - ```sh - npm install npm@latest -g - ``` - -### Installation - -1. Get a free API Key at [https://example.com](https://example.com) -2. Clone the repo - ```sh - git clone https://github.com/zucchero-sintattico/pps-22-scatan.git - ``` -3. Install NPM packages - ```sh - npm install - ``` -4. Enter your API in `config.js` - ```js - const API_KEY = "ENTER YOUR API"; - ``` - -

(back to top)

- - - -## Usage - -Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. - -_For more examples, please refer to the [Documentation](https://zucchero-sintattico.github.io/pps-22-scatan/scaladoc/)_ - -

(back to top)

+You can play the game by clicking on the following link: [Scatan](https://zucchero-sintattico.github.io/pps-22-scatan/) @@ -151,26 +101,26 @@ Don't forget to give the project a star! Thanks again! 4. Push to the Branch (`git push origin feature/AmazingFeature`) 5. Open a Pull Request -

(back to top)

- ## License -Distributed under the MIT License. See `LICENSE.txt` for more information. - -

(back to top)

+Distributed under the MIT License. See [LICENSE](https://github.com/zucchero-sintattico/pps-22-scatan/blob/feature-readme/LICENSE) for more information. -## Contacts +## Contact -- Luigi Borriello - luigi.borriello2@studio.unibo.it -- Alessandro Mazzoli - alessandro.mazzoli9@studio.unibo.it -- Manuel Andruccioli - manuel.andruccioli@studio.unibo.it +Zucchero Sintattico on Instagram - [@Instagram page](https://www.instagram.com/zucchero_sintattico/) Project Link: [https://github.com/zucchero-sintattico/pps-22-scatan](https://github.com/zucchero-sintattico/pps-22-scatan) +## Acknowledgements + +- [Luigi Borriello](https://www.linkedin.com/in/luigi-borriello/) +- [Alessandro Mazzoli](https://www.linkedin.com/in/alessandro-mazzoli-009868140/) +- [Manuel Andruccioli](https://www.linkedin.com/in/manuel-andruccioli-9259a5189/) +

(back to top)