Skip to content

Commit 68054cb

Browse files
update README
1 parent 4dd7e86 commit 68054cb

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

npm-package/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Squeeel
22

3-
Make your raw SQL queries type-safe instantly.
3+
Make your raw SQL queries type-safe.
44

55
Squeeel is a CLI tool that analyzes your codebase to find all your raw SQL queries and automatically generates TypeScript types for both query parameters and return values. This means you get full type safety and autocompletion for your SQL queries without any runtime overhead or query builder complexity.
66

@@ -75,6 +75,15 @@ Squeeel is designed for developers who prefer writing raw SQL queries. While que
7575

7676
Squeeel gives you the best of both worlds: the power and flexibility of raw SQL with the type safety of a query builder.
7777

78+
## Contributing
79+
80+
Thanks for considering contributing, any help is very welcome!
81+
The primary things to contribute to is
82+
83+
- using it in projects to find rough edges, and improvements
84+
- Extending to more libraries, [see](https://github.com/SorenHolstHansen/squeeel/issues/1)
85+
- Bug fixes
86+
7887
## Acknowledgements
7988

8089
We use the following other projects extensively, without which, squeeel would likely not have been possible.

0 commit comments

Comments
 (0)