Skip to content

Commit d2d6872

Browse files
committed
chore: change README one last time
1 parent 4bd395f commit d2d6872

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,21 @@ Now you have a user called `googleapis` with password `googleapis` \
3636
And a module with `googleapis` name that has some protos in it alongside a project
3737
that uses this as its dependency in `protos/simpleproject`
3838

39-
Enjoy developing
39+
I coded this fast, focusing on getting things working first rather than following the best practices from day one. So there’s room for improvement, refactoring, and optimizations.
40+
41+
If you spot something that could be improved, better architecture, cleaner code, or best practices, feel free to open an issue or a PR. Your contributions are highly appreciated!
42+
43+
Enjoy hacking on Hades!
4044

4145
### Features ready to tests:
4246
1. buf dep update
4347
2. buf push
48+
Navigate to `development/protos/simpleproject` and run:
4449

45-
go to `development/protos/simpleproject` \
46-
use `buf dep update` to update your googleapis dependency \
47-
now use `buf genereate` to generate the codes. \
50+
```bash
51+
buf dep update # Updates the googleapis dependency
52+
buf generate # Generates codes
53+
```
4854
NOTE: the SKD module is not yet developed.
4955

5056
You can also change the protos in `development/protos/googleapis` and then push them using `buf push`

ROADMAP.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## Overview
44
This document planned features for the project.
55

6+
- [ ] Use pgx instead of gorm
67
- [X] Development Bootstrap environment
78
- [ ] E2E Tests
89
- [X] Dockerize the project

0 commit comments

Comments
 (0)