Update README.md

This commit is contained in:
Ryan Freeman 2023-08-01 18:52:28 +01:00 committed by GitHub
parent 0edbaf5573
commit 43bad2c34b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -14,11 +14,11 @@ and skills, as well as provide information about me and my interests.
## Project structure ## Project structure
- `app/` - App router.
- `app/api/` - API routes for article views and Spotify integrations.
- `app/writing/` - Blog posts written in MDX format (Markdown in JSX).
- `components/` - All the components of the website in tsx format. - `components/` - All the components of the website in tsx format.
- `lib/` - Useful functions and scripts for connecting to external services and so on. - `lib/` - Useful functions and scripts for connecting to external services and so on.
- `pages/api/` - API routes for article views and Spotify integrations.
- `pages/writing/` - Blog posts written in MDX format (Markdown in JSX).
- `pages/` - Contains all other static pages like about, projects and uses.
- `public/` - Used for static files such as icons and images. - `public/` - Used for static files such as icons and images.
- `styles/` - Contains the stylesheets for Tailwind and Prism. - `styles/` - Contains the stylesheets for Tailwind and Prism.
- `types/` - Types for various components in the project. - `types/` - Types for various components in the project.
@ -34,4 +34,4 @@ npm i
npm run dev npm run dev
``` ```
Create a `.env.local` file using `.env.example` as a template. Create a `.env.local` file using `.env.example` as a template.