Skip to content

Commit

Permalink
chore(README.md): πŸ“ Tidy up the readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
arienshibani committed Jul 3, 2024
1 parent 461efe7 commit b1e84d3
Showing 1 changed file with 10 additions and 20 deletions.
30 changes: 10 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,28 @@
<h3 align="center">Photography Portfolio</h3>
<h1 align="center">Photography Portfolio App</h3>

<div align="center">

[![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)

</div>

---

<p align="center"> 120mm black and white Photography portfolio πŸ“Έ
<p align="center"> 120mm black and white Photography portfolio πŸ“Έ Powered by SvelteKit and ImageKit!
<br>
</p>

## πŸ“ Table of Contents
- [About](#about)
- [Getting Started](#getting_started)
- [Deployment](#deployment)
- [Usage](#usage)
- [Built Using](#built_using)

## 🧐 About <a name = "about"></a>
[Arien Shibani](https://www.linkedin.com/in/arienshibani/)'s collection of 120mm photography.

## 🏁 Getting Started <a name = "getting_started"></a>
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 <a name = "getting_started"></a>
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
Expand All @@ -43,8 +33,8 @@ git clone git@github.com:arienshibani/photo-portfolio.git
npm install
```

## 🎈 Usage <a name="usage"></a>
```bash
# 3. Start the app!
npm run dev
```

Expand All @@ -53,4 +43,4 @@ Automatic deploys to github pages whenever anything is merged into main.

## ⛏️ Built Using <a name = "built_using"></a>
- [SvelteKit](https://kit.svelte.dev/) - Web application framework
- [ImageKit](https://imagekit.com) - Used as a image CDN
- [ImageKit](https://imagekit.com) - Image CDN

0 comments on commit b1e84d3

Please sign in to comment.