From 90bcfbf0d49e428e6b4bb45c511e4a60cecaff49 Mon Sep 17 00:00:00 2001
From: Alam Guardin <alamguardin@gmail.com>
Date: Fri, 9 Aug 2024 21:13:55 -0500
Subject: chore: update readme.md content

---
 README.md | 44 +++++++++++++++++++++++++-------------------
 1 file changed, 25 insertions(+), 19 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 1db3fb3..cdf9768 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,32 @@
-# Astro Starter Kit: Basics
+# Astrolink: Template to share about yourself
 
 ```sh
-npm create astro@latest -- --template basics
+git clone https://github.com/alamguardin/Astrolink.git
 ```
 
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
-[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics)
-[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json)
 
-> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+![Preview](/src/assets/screenshot-app.png)
 
-![just-the-basics](https://github.com/withastro/astro/assets/2244813/a0a5533c-a856-4198-8470-2d67b1d7c554)
+## 🚀 How to change the content?
 
-## 🚀 Project Structure
-
-Inside of your Astro project, you'll see the following folders and files:
+To change the content of the templates, simply locate the ```user.json``` file inside the data folder. You can change the name, profession, and the links you want.
 
 ```text
 /
 ├── public/
 │   └── favicon.svg
 ├── src/
+│   ├── assets/
+│   │   └── screenshot-app.png
+│   │   └── user-profile-image.png
 │   ├── components/
-│   │   └── Card.astro
+│   │   └── icons/
+│   │   └── Link.astro
+│   │   └── List.astro
+│   │   └── Profile.astro
+│   │   └── Shadow.astro
+│   ├── data/
+│   │   └── user.json
 │   ├── layouts/
 │   │   └── Layout.astro
 │   └── pages/
@@ -30,11 +34,17 @@ Inside of your Astro project, you'll see the following folders and files:
 └── package.json
 ```
 
-Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
-
-There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
+Oh, you also have a list of icons that you can use for your links by simply putting the name in the ```icon``` key of each link.
 
-Any static assets, like images, can be placed in the `public/` directory.
+- ```dribbble```
+- ```facebook```
+- ```instagram```
+- ```linkedin```
+- ```shop```
+- ```twitch```
+- ```url```
+- ```xtwitter```
+- ```youtube```
 
 ## 🧞 Commands
 
@@ -48,7 +58,3 @@ All commands are run from the root of the project, from a terminal:
 | `npm run preview`         | Preview your build locally, before deploying     |
 | `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
 | `npm run astro -- --help` | Get help using the Astro CLI                     |
-
-## 👀 Want to learn more?
-
-Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
-- 
cgit v1.2.3