Skip to content

Commit

Permalink
specify dual-licensing in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dmonad committed Jul 14, 2024
1 parent 88ecd65 commit 43232f5
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 23 deletions.
30 changes: 8 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,13 @@ Postgres, or implement your own storage provider.

### Licensing

Currently, this project is proprietary. This software is mainly targeted for large
companies that want a scalable y-redis backend. Please contact me to buy a
license: <kevin.jahns at pm.me>
y-redis is dual-licensed (either [AGPL](./LICENSE) or proprietary).

Please contact me to buy a license if you intend to use y-redis in your
commercial product: <kevin.jahns at pm.me>

Otherwise, you may use this software under the terms of the AGPL, which requires
you to pubsh your source code under the terms of the AGPL too.

### Components

Expand Down Expand Up @@ -58,20 +62,6 @@ whether a specific client (authenticated via a JWT token) has access to a
specific room / document. Example servers can be found in
`/bin/auth-server-example.js` and `/demos/auth-express/server.js`.

## Professional support

As this server implementation is clearly intended for startups & large companies
that want a scalable backend to their collaborative product, I thought about
commercializing this piece of software. Ultimately I decided against it, because
permissively licensed software like this has more positive impact on humanity
overall. However, it does make sense to cantact me for a consulting call to
evaluate whether this is the right approach for you. Any (small) contribution is
highly appreciated.

Please support my work by [becoming a
sponsor](https://github.com/sponsors/dmonad) or hiring me as a consultant for
professional support and security updates.

### Missing Features

I'm looking for sponsors that want to sponsor the following work:
Expand All @@ -86,7 +76,7 @@ I'm looking for sponsors that want to sponsor the following work:
- Perform expensive tasks (computing sync messages) in separate threads

If you are interested in sponsoring some of this work, please send a mail to
<kevin.jahns@pm.me>
<kevin.jahns at pm.me>.

# Quick Start (docker-compose)

Expand Down Expand Up @@ -199,7 +189,3 @@ npm start
```

Open [`http://localhost:5173`](http://localhost:5173) in a browser.

## License

Proprietary - please contact me to buy a license <kevin.jahns at pm.me>
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
"Yjs"
],
"author": "Kevin Jahns <[email protected]>",
"license": "PROPRIETARY",
"license": "AGPL-3.0 OR PROPRIETARY",
"bugs": {
"url": "https://github.com/yjs/y-redis/issues"
},
Expand Down

0 comments on commit 43232f5

Please sign in to comment.