socketdb

Real-time synchronized data storage

Usage no npm install needed!

<script type="module">
  import socketdb from 'https://cdn.skypack.dev/socketdb';
</script>

README

logo
SocketDB

Real-time synchronized data storage

Version Documentation License: MIT

· Homepage · Report Bug / Request Feature ·

Table of Contents

➡️ Documentation

You can find the documentation here: https://timobechtel.github.io/socketdb

Install

yarn add -D socketdb

Run tests

yarn test

🤝 Contributing

Contributions, issues and feature requests are welcome!

  1. Check issues
  2. Fork the project
  3. Create your feature branch (git checkout -b feat/AmazingFeature)
  4. Test your changes yarn run test
  5. Commit your changes (git commit -m 'feat: add amazingFeature')
  6. Push to the branch (git push origin feat/AmazingFeature)
  7. Open a pull request

Commit messages

This project uses semantic-release for automated release versions. So commits in this project follow the Conventional Commits guidelines. I recommend using commitizen for automated commit messages.

Show your support

Give a ⭐️ if this project helped you!

📝 License

This project is MIT licensed.

Author

👤 Timo Bechtel

This README was generated with ❤️ by readme-md-generator