Skip to content
This repository was archived by the owner on Nov 17, 2023. It is now read-only.

Commit aae5065

Browse files
committed
Update README.md
1 parent da61990 commit aae5065

File tree

1 file changed

+27
-15
lines changed

1 file changed

+27
-15
lines changed

README.md

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,35 @@
1-
# next-template
1+
![GitHub contributors](https://img.shields.io/github/contributors/DevyusCode/DevDocGPT)
2+
![GitHub issues](https://img.shields.io/github/issues/DevyusCode/DevDocGPT)
3+
![GitHub](https://img.shields.io/github/license/DevyusCode/DevDocGPT)
4+
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/DevyusCode/DevDocGPT)
5+
![Nuget](https://img.shields.io/nuget/dt/PeyrSharp)
26

3-
A Next.js 13 template for building apps with Radix UI and Tailwind CSS.
7+
<br />
8+
<p align="center">
9+
<a href="https://github.com/DevyusCode/DevDocGPT">
10+
<img src=".github/images/logo.png" alt="Logo" width="80" height="80">
11+
</a>
412

5-
## Usage
13+
<h1 align="center">DevDocGPT</h1>
614

7-
```bash
8-
npx create-next-app -e https://github.com/shadcn/next-template
9-
```
15+
<p align="center">
16+
Generate markdown documentation easily with the power of AI.
17+
<br />
18+
<a href=""><strong>Try it »</strong></a>
19+
<br />
20+
<a href="https://github.com/DevyusCode/DevDocGPT/issues/new?assignees=&labels=bug&template=bug-report.yml&title=%5BBug%5D+">Report Bug</a>
21+
·
22+
<a href="https://github.com/DevyusCode/DevDocGPT/issues/new?assignees=&labels=enhancement&template=feature-request.yml&title=%5BEnhancement%5D+">Request Feature</a>
1023

11-
## Features
24+
</p>
25+
</p>
1226

13-
- Radix UI Primitives
14-
- Tailwind CSS
15-
- Fonts with `next/font`
16-
- Icons from [Lucide](https://lucide.dev)
17-
- Dark mode with `next-themes`
18-
- Automatic import sorting with `@ianvs/prettier-plugin-sort-imports`
19-
- Tailwind CSS class sorting, merging and linting.
27+
## Introduction
28+
29+
DevDocGPT is a tool that generates documentation using OpenAI’s GPT models. It is based on the idea of using natural language processing to create markdown files from plain text inputs. DevDocGPT can help developers and writers to produce high-quality documentation for their projects, without having to spend too much time on formatting and structuring.
30+
31+
DevDocGPT uses GPT-3, the latest and most advanced model of OpenAI, which has 175 billion parameters and can generate coherent and diverse texts on various topics. DevDocGPT leverages the power of GPT-3 to understand the context and the intent of the input text, and to generate relevant and informative documentation in markdown format. DevDocGPT can also use GPT-4.
2032

2133
## License
2234

23-
Licensed under the [MIT license](https://github.com/shadcn/ui/blob/main/LICENSE.md).
35+
This project is under the [MIT License](LICENSE)

0 commit comments

Comments
 (0)