Skip to content

Commit

Permalink
[nop] [Docs] Update README template
Browse files Browse the repository at this point in the history
  • Loading branch information
ptaoussanis committed Jun 1, 2023
1 parent cd72f7c commit cdbe417
Showing 1 changed file with 25 additions and 17 deletions.
42 changes: 25 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<a href="https://www.taoensso.com/clojure" title="More stuff by @ptaoussanis at www.taoensso.com">
<img src="https://www.taoensso.com/taoensso-open-source.png" alt="Taoensso open-source" width="480""/></a>
<img src="https://www.taoensso.com/taoensso-open-source.png" alt="Taoensso open-source" width="380""/></a>

# Sente

Expand All @@ -9,7 +9,7 @@

Loosely inspired by [Socket.IO](https://socket.io/), it uses **core.async**, **WebSockets**, and **Ajax** under the hood to provide a simple high-level API that enables **reliable, high-performance, bidirectional communications**.

![Hero](https://raw.githubusercontent.com/ptaoussanis/sente/master/hero.jpg "Source: http://almostsente.tumblr.com/")
<img src="https://raw.githubusercontent.com/ptaoussanis/sente/master/hero.jpg" width="600">

> **Sen-te** (先手) is a Japanese [Go](https://en.wikipedia.org/wiki/Go_(game)) term used to describe a play with such an overwhelming follow-up that it demands an immediate response, leaving its player with the initiative.
Expand All @@ -18,37 +18,45 @@ Loosely inspired by [Socket.IO](https://socket.io/), it uses **core.async**, **W
- 2023-05-30: `1.18.0-RC1` (dev): [release notes](https://github.com/ptaoussanis/sente/releases/tag/v1.18.0-RC1) | [Clojars](https://clojars.org/com.taoensso/sente/versions/1.18.0-RC1)
- 2022-06-13: `1.17.0` (stable): [release notes](https://github.com/ptaoussanis/sente/releases/tag/v1.17.0) | [Clojars](https://clojars.org/com.taoensso/sente/versions/1.17.0)

## Features
* **Bidirectional a/sync comms** over **WebSockets** with **auto Ajax fallback**
* **It just works**: auto keep-alives, buffering, protocol selection, reconnects
* Efficient design with transparent event batching for **low-bandwidth use, even over Ajax**
* Send **arbitrary Clojure vals** over [edn](https://github.com/edn-format/edn
) or [Transit](https://github.com/cognitect/transit-clj) (JSON, MessagePack, etc.)
* **Tiny API** (see the [wiki][] for details)
* Automatic, sensible support for users connected with **multiple clients** and/or devices simultaneously
* Realtime info on **which users are connected** over which protocols
* Standard **Ring security model**: auth as you like, HTTPS when available, CSRF support, etc.
* Support for [several popular web servers](https://github.com/ptaoussanis/sente/tree/master/src/taoensso/sente/server_adapters), [easily extended](https://github.com/ptaoussanis/sente/blob/master/src/taoensso/sente/interfaces.cljc) to other servers.
<!--- [![tests][tests badge]][tests status] -->

## Resources
1. [Wiki][wiki] - **community docs** (new!) 👈
1. [Wiki][wiki] - **community docs** (👈 start here)
1. [Release info][] - releases and changes
1. [API docs][] - auto-generated API docs
1. [GitHub issues][] - for support requests, contributions, etc.

## Features

* **Bidirectional a/sync comms** over **WebSockets** with **auto Ajax fallback**
* **It just works**: auto keep-alives, buffering, protocol selection, reconnects
* Efficient design with transparent event batching for **low-bandwidth use, even over Ajax**
* Send **arbitrary Clojure vals** over [edn](https://github.com/edn-format/edn
) or [Transit](https://github.com/cognitect/transit-clj) (JSON, MessagePack, etc.)
* **Tiny API** (see the [wiki][] for details)
* Automatic, sensible support for users connected with **multiple clients** and/or devices simultaneously
* Realtime info on **which users are connected** over which protocols
* Standard **Ring security model**: auth as you like, HTTPS when available, CSRF support, etc.
* Support for [several popular web servers](https://github.com/ptaoussanis/sente/tree/master/src/taoensso/sente/server_adapters), [easily extended](https://github.com/ptaoussanis/sente/blob/master/src/taoensso/sente/interfaces.cljc) to other servers.

## Funding this work

Please see [here][funding] if you'd like to help support continued my [open-source work][], thank you! 🙏 - Peter
Please see [here][funding] if you'd like to help support my continued [open-source work][] (thank you!! 🙏) - Peter

## License

Copyright &copy; 2014-2023 [Peter Taoussanis][], licensed under [EPL 1.0][] (same as Clojure).

<!--- Common links -->
[wiki]: ../../wiki
[Release info]: ../../releases
[API docs]: http://ptaoussanis.github.io/sente/
[GitHub issues]: ../../issues
[funding]: https://taoensso.com/clojure/backers
[EPL 1.0]: LICENSE
[Peter Taoussanis]: https://www.taoensso.com
[open-source work]: https://www.taoensso.com/clojure
[open-source work]: https://www.taoensso.com/clojure

<!--- Repo links -->
[API docs]: http://ptaoussanis.github.io/sente/
[tests badge]: https://github.com/ptaoussanis/sente/actions/workflows/tests.yml/badge.svg
[tests status]: https://github.com/ptaoussanis/sente/actions/workflows/tests.yml

0 comments on commit cdbe417

Please sign in to comment.