diff --git a/README.md b/README.md index 5a06e62..f5eb214 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,28 @@ -

Photography Portfolio

+

Photography Portfolio App

- [![Status](https://img.shields.io/badge/webpage-online-live.svg)](beans) + [![Status](https://img.shields.io/badge/webpage-online-live.svg)](beans) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
--- -

120mm black and white Photography portfolio 📸 +

120mm black and white Photography portfolio 📸 Powered by SvelteKit and ImageKit!

-## 📝 Table of Contents -- [About](#about) -- [Getting Started](#getting_started) -- [Deployment](#deployment) -- [Usage](#usage) -- [Built Using](#built_using) -## 🧐 About -[Arien Shibani](https://www.linkedin.com/in/arienshibani/)'s collection of 120mm photography. -## 🏁 Getting Started -These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system. +## 🏁 Quickstart +This section describes how to get a running copy of this portfolio web app on your local machine. ### Prerequisites -You will need Node installed on your system to develop and run this project locally. -* [Node](https://nodejs.org/en/download/package-manager) - -### Installing -This section describes how you can install the source code, and it's dependancies on your local machine. +You will need Node installed on your system. +* [Node LTS](https://nodejs.org/en/download/package-manager) +### Installation ```bash # 1. Clone the repository git clone git@github.com:arienshibani/photo-portfolio.git @@ -43,8 +33,8 @@ git clone git@github.com:arienshibani/photo-portfolio.git npm install ``` -## 🎈 Usage ```bash +# 3. Start the app! npm run dev ``` @@ -53,4 +43,4 @@ Automatic deploys to github pages whenever anything is merged into main. ## ⛏️ Built Using - [SvelteKit](https://kit.svelte.dev/) - Web application framework -- [ImageKit](https://imagekit.com) - Used as a image CDN +- [ImageKit](https://imagekit.com) - Image CDN