Skip to content

Commit

Permalink
Update readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
steida committed Dec 1, 2023
1 parent e4902c1 commit ec40c50
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 16 deletions.
12 changes: 12 additions & 0 deletions packages/evolu-common-react/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# Evolu Common for React

Common code for Evolu React and Evolu React Native.

## Documentation

For detailed information and usage examples, please visit [evolu.dev](https://www.evolu.dev).

## Community

The Evolu community is on [GitHub Discussions](https://github.com/evoluhq/evolu/discussions), where you can ask questions and voice ideas.

To chat with other community members, you can join the [Evolu Discord](https://discord.gg/2J8yyyyxtZ).

[![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/evoluhq.svg?style=social&label=Follow%20%40evoluhq)](https://twitter.com/evoluhq)
12 changes: 12 additions & 0 deletions packages/evolu-common-web/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# Evolu Common for Web

Common code for Evolu React and other UI libraries for the web.

## Documentation

For detailed information and usage examples, please visit [evolu.dev](https://www.evolu.dev).

## Community

The Evolu community is on [GitHub Discussions](https://github.com/evoluhq/evolu/discussions), where you can ask questions and voice ideas.

To chat with other community members, you can join the [Evolu Discord](https://discord.gg/2J8yyyyxtZ).

[![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/evoluhq.svg?style=social&label=Follow%20%40evoluhq)](https://twitter.com/evoluhq)
12 changes: 12 additions & 0 deletions packages/evolu-react-native/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# Evolu for React Native

[Evolu](https://github.com/evoluhq/evolu) for [React Native](https://reactnative.dev/).

## Documentation

For detailed information and usage examples, please visit [evolu.dev](https://www.evolu.dev).

## Community

The Evolu community is on [GitHub Discussions](https://github.com/evoluhq/evolu/discussions), where you can ask questions and voice ideas.

To chat with other community members, you can join the [Evolu Discord](https://discord.gg/2J8yyyyxtZ).

[![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/evoluhq.svg?style=social&label=Follow%20%40evoluhq)](https://twitter.com/evoluhq)
23 changes: 7 additions & 16 deletions packages/evolu-server/README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,15 @@
# Evolu Server

Node.js server for Evolu library.
Evolu server for Evolu library.

Evolu is designed for privacy, ease of use, and no vendor lock-in.
## Documentation

## Requirements
For detailed information and usage examples, please visit [evolu.dev](https://www.evolu.dev).

- TypeScript 5.0 or newer
- The `strict` flag enabled in your `tsconfig.json` file
## Community

## Getting Started
The Evolu community is on [GitHub Discussions](https://github.com/evoluhq/evolu/discussions), where you can ask questions and voice ideas.

```bash
npm install @evolu/server
npm run build
npm start
```
To chat with other community members, you can join the [Evolu Discord](https://discord.gg/2J8yyyyxtZ).

## Deploy to fly.io

- https://fly.io/docs/languages-and-frameworks/node/

For quick testing, write `flyctl launch` and confirm a deployment. Note that without a Fly Volume, the database with be reset on every deployment.
[![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/evoluhq.svg?style=social&label=Follow%20%40evoluhq)](https://twitter.com/evoluhq)

1 comment on commit ec40c50

@vercel
Copy link

@vercel vercel bot commented on ec40c50 Dec 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

evolu – ./

evolu-evolu.vercel.app
evolu-git-main-evolu.vercel.app
evolu.vercel.app
evolu.dev
www.evolu.dev

Please sign in to comment.