diff --git a/README.md b/README.md index bba5b27..f26834b 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,14 @@ -

- - Wocket - -

Wocket

-

-

A WebSocket library for Deno.

-

- - - - - - - - - - - - -

+# Wocket ---- +[![Latest Release](https://img.shields.io/github/release/drashland/wocket.svg?color=bright_green&label=latest)](https://github.com/drashland/wocket/releases/latest) +[![CI - Main](https://img.shields.io/github/workflow/status/drashland/wocket/Master/main?label=ci%20-%20main)](https://github.com/drashland/wocket/actions/workflows/master.yml) -**_Although Wocket has working code, it is still very much under development and -unstable. APIs will change without notice. Sorry for any inconvenience!_** +Drash Land - Wocket logo -### Getting Started +Wocket is a WebSocket library for Deno. -Get started [here](https://drash.land/wocket/#/#quickstart) to build a basic -WebSocket server using Wocket. +View the full documentation at https://drash.land/wocket. -Alternatively, you can navigate through the -[full documentation](https://drash.land/wocket) and check out the tutorials. - -### Features - -- JSON encoding -- Zero 3rd party dependencies - ---- - -Want to contribute? Follow the Contributing Guidelines -[here](https://github.com/drashland/.github/blob/master/CONTRIBUTING.md). All -code is released under the [MIT License](./LICENSE). +In the event the documentation pages are not accessible, please view the raw +version of the documentation at +https://github.com/drashland/website-v2/tree/main/docs.