Skip to content

Commit 3518c5f

Browse files
committed
docs: added some more documentation and correct Favicon
1 parent a40ba71 commit 3518c5f

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11
# api-docs.phpmyfaq.de
22

3+
The official phpMyFAQ API documentation is built with [Next.js](https://nextjs.org/) and
4+
[Tailwind CSS](https://tailwindcss.com/), hosted on [Vercel](https://www.vercel.com/).
5+
36
## Getting Started
47

58
First, run the development server:
69

710
```bash
811
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
1512
```
1613

1714
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
1815

16+
## Deployment
17+
18+
To deploy the project, just push the current branch to the `main` branch. Vercel will automatically deploy the changes.
19+
1920
## Copyright
2021

2122
Copyright © 2001–2024 Thorsten Rinne and the phpMyFAQ Team

app/favicon.ico

13.8 KB
Binary file not shown.

app/layout.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ const inter = Inter({ subsets: ["latin"] });
77
export const metadata: Metadata = {
88
title: "API Docs for phpMyFAQ",
99
description: "phpMyFAQ API documentation",
10+
applicationName: "phpMyFAQ API",
1011
};
1112

1213
export default function RootLayout({

0 commit comments

Comments
 (0)