Skip to content

Commit ef92b89

Browse files
committed
updating readme
1 parent 181490a commit ef92b89

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

README.md

+23-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,25 @@
11
# [GramrFixr.com](http://gramrfixr.com)
22

3-
- Add screenshot / demo
4-
- Add description
3+
This project fixes your grammar using OpenAI GPT-3.
4+
5+
[![GramrFixr](./public/gramrfixr_screenshot.png)](https://www.gramrfixr.com/)
6+
7+
## How it works
8+
9+
The project uses the [OpenAI GPT-3 API](https://openai.com/blog/openai-api/) to fix your grammar.
10+
11+
## Running Locally
12+
13+
After cloning the repo, go to [OpenAI](https://beta.openai.com/) and create an account and put your API key in an .env file. You can create one by renaming .env.example to .env and putting your API key in there.
14+
15+
Then, run the development server first install the packages:
16+
17+
```bash
18+
npm install
19+
```
20+
21+
and then run the development server:
22+
23+
```bash
24+
npm run dev
25+
```

public/gramrfixr_screenshot.png

96.4 KB
Loading

0 commit comments

Comments
 (0)