Skip to content

Commit ceca43f

Browse files
committed
feat: README
1 parent ec55f9e commit ceca43f

1 file changed

Lines changed: 21 additions & 29 deletions

File tree

README.md

Lines changed: 21 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,28 @@
1-
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
1+
# MD Chat
22

3-
## Getting Started
3+
<p align="center">
4+
<img src="https://cdn.mikn.dev/branding/mikan-vtube.svg" width="100">
5+
</p>
46

5-
First, run the development server:
7+
<p align="center">The GPT Weapper for your AI</p>
68

7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
15-
```
16-
17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
18-
19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
20-
21-
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
9+
- Chat with a variety of AI models
10+
- Supports model providers, OpenRouter and even local models!
11+
- Share chats with others
12+
- Generate images
13+
- Attach files to your chats for models that support it
14+
- Integrate with your own infrastructure with Ollama
2215

23-
## Learn More
16+
## Installation
2417

25-
To learn more about Next.js, take a look at the following resources:
26-
27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
29-
30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
31-
32-
## Deploy on Vercel
18+
```bash
19+
docker pull ghcr.io/mikndotdev/chat:latest
20+
```
21+
Read the [selfhosting documentation](https://docs.mikn.dev/solutions/selfhost-guides/md-chat/) for more info!
3322

34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
23+
## Try it Out
24+
A hosted version of this app is available at [chat.mikn.dev](https://chat.mikn.dev/).<br>
3525

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
26+
## Open Source
27+
MD Chat is open source and available under the MIT License.<br>
28+
Feel free to [contribute](https://github.com/mikndotdev/chat) and add features or report bugs!

0 commit comments

Comments
 (0)