Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
TheTeaCat committed Jul 11, 2022
1 parent c319591 commit a99a65d
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ It's a timer app. You can use it for things like:
- Seeing how long it is until your next birthday 🎂
- Counting down the days until your next holiday 🏖️

[![Netlify Status](https://api.netlify.com/api/v1/badges/bf156c24-1095-472d-85f7-f6a198573159/deploy-status)](https://app.netlify.com/sites/subtle-entremet-488072/deploys)
All of the little drawing animations were implemented using [Rough Notation](https://roughnotation.com/).



## Development Setup

TilTi.me is a Vue 3 + TS project setup using Vite.
TilTi.me is a [Vue 3](https://vuejs.org/) + TS project setup using [Vite](https://vitejs.dev/).

```bash
git clone [email protected]:two-twelve/tiltime.git
Expand All @@ -19,19 +21,21 @@ npm install
npm run dev
```

Eslint and Prettier have also been setup on TilTi.me:
[Eslint](https://eslint.org/) and [Prettier](https://prettier.io/) have also been setup on TilTi.me:

```bash
npm run format
npm run lint
```

And tests have been implemented using Jest:
And tests have been implemented using [Jest](https://jestjs.io/):

```bash
npm run test
```



## Production Deployment

You can build TilTi.me for deployment by doing:
Expand All @@ -45,3 +49,5 @@ You'll find all your static files in `/dist`. You can preview a production deplo
```bash
npm run preview
```

We deploy tilti.me to [Cloudflare Pages](https://pages.cloudflare.com/) :)

0 comments on commit a99a65d

Please sign in to comment.