Skip to content

Commit

Permalink
chore(readme): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
NeutronicMC committed May 28, 2024
1 parent 471c4bb commit 982df88
Show file tree
Hide file tree
Showing 2 changed files with 1,032 additions and 432 deletions.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
# hive-tools-database

Built with Postgres and DrizzleORM, with zod for type-safety.
Built with [Postgres](https://www.postgresql.org/) and [DrizzleORM](https://drizzle-orm.com/), with
[zod](https://github.com/colinhacks/zod) for type-safety.

## Usage

> [!NOTE]
> This project is currently unlicensed, meaning Paroxity retains all rights to the code. Usage by other projects is
> currently prohibited for the time being. We will be adding an open source license before the full release.
This project is intended to be used as a library. Paroxity is using it by including it as a submodule in
[Hive Tools](https://hivetools.app).

## Development

This project uses [pnpm](https://pnpm.io/) as a package manager. Get started by running

```bash
pnpm install
```

## Contributing

As of right now, this project is not open source and therefore not accepting contributions.
Loading

0 comments on commit 982df88

Please sign in to comment.