Skip to content

Commit 4720601

Browse files
committed
add license
1 parent 9dc4e41 commit 4720601

File tree

2 files changed

+28
-3
lines changed

2 files changed

+28
-3
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Kalle Ilves
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Docker and [Ollama](https://ollama.com/).
2222
2323
### REST API
2424

25-
REST API endpoint `POST http://localhost:3000/api/repos/{owner}/{repo}/prompt` (e.g. <http://localhost:3000/api/repos/Kaltsoon/rag-my-docs>) accepts a request body in the following format:
25+
REST API endpoint `POST http://localhost:3000/api/repos/{owner}/{repo}/prompt` (e.g. <http://localhost:3000/api/repos/Kaltsoon/rag-my-docs/prompt>) accepts a request body in the following format:
2626

2727
```json
2828
{
@@ -39,7 +39,7 @@ The response contains the answer from the LLM.
3939
Here's an example request using `curl`:
4040

4141
```bash
42-
curl -X POST http://http://localhost:3000/api/repos/Kaltsoon/rag-my-docs \
42+
curl -X POST http://http://localhost:3000/api/repos/Kaltsoon/rag-my-docs/prompt \
4343
-H "Content-Type: application/json" \
4444
-d '{"question":"What is the purpose of the repository?"}'
4545
```
@@ -54,4 +54,8 @@ You can run the CLI application by running `docker compose exec -it app npm run
5454

5555
### Debugging
5656

57-
Setting `LOGGER_LEVEL=debug` in the `.env` file will enable logging and provide information on, for example, cache performance.
57+
Setting `LOGGER_LEVEL=debug` in the `.env` file will enable logging and provide information on, for example, cache performance.
58+
59+
## License
60+
61+
[MIT](./LICENSE)

0 commit comments

Comments
 (0)