Skip to content

Commit

Permalink
chore(readme): udpate readme to match drash v2
Browse files Browse the repository at this point in the history
  • Loading branch information
crookse committed Dec 18, 2021
1 parent 556b6a9 commit c67deb7
Showing 1 changed file with 9 additions and 40 deletions.
49 changes: 9 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,14 @@
<p align="center">
<a href="https://drash.land/wocket">
<img height="200" src="logo.svg" alt="Wocket">
</a>
<h1 align="center">Wocket</h1>
</p>
<p align="center">A WebSocket library for <a href="https://github.com/denoland/deno">Deno</a>.</p>
<p align="center">
<a href="https://github.com/drashland/wocket/releases">
<img src="https://img.shields.io/github/release/drashland/wocket.svg?color=bright_green&label=latest">
</a>
<a href="https://github.com/drashland/wocket/actions">
<img src="https://img.shields.io/github/workflow/status/drashland/wocket/master?label=ci">
</a>
<a href="https://discord.gg/SgejNXq">
<img src="https://img.shields.io/badge/chat-on%20discord-blue">
</a>
<a href="https://twitter.com/drash_land">
<img src="https://img.shields.io/twitter/url?label=%40drash_land&style=social&url=https%3A%2F%2Ftwitter.com%2Fdrash_land">
</a>
</p>
# 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!_**
<img align="right" src="./logo.svg" alt="Drash Land - Wocket logo" width="150" style="max-width: 150px">

### 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.

0 comments on commit c67deb7

Please sign in to comment.