Skip to content

Commit

Permalink
Rework readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Syndesi committed Jun 2, 2024
1 parent bb925c9 commit a2b83ec
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@
# Ember Nexus: Web SDK

The Web SDK is a typescript library intended to be used by developers and separate web applications.
![GitHub License](https://img.shields.io/github/license/ember-nexus/web-sdk)
[![NPM Version](https://img.shields.io/npm/v/%40ember-nexus%2Fweb-sdk)](https://www.npmjs.com/package/@ember-nexus/web-sdk)
![NPM Downloads](https://img.shields.io/npm/dm/%40ember-nexus%2Fweb-sdk)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ember-nexus/web-sdk/ci-test.yml?label=CI)
[![codecov](https://codecov.io/gh/ember-nexus/web-sdk/branch/main/graph/badge.svg?token=N4U7IE0DK0)](https://codecov.io/gh/ember-nexus/web-sdk)
[![Discord](https://img.shields.io/discord/1135243882360221787?logo=discord&color=%235865f2)](https://discord.gg/qbQFBrJrRC)

The Web SDK is a TypeScript library intended to be used by developers and separate web applications.
It is programmed in a framework-agnostic way.

The Web SDK is a library intended to make working with the [Ember Nexus API](https://github.com/ember-nexus/api)
easier.
It is programmed in a framework-agnostic way.

## Quick Links

- [Check out the documentation](https://ember-nexus.github.io/web-sdk)
- [Find us on NPM](https://www.npmjs.com/package/@ember-nexus/web-sdk)

Find us on [GitHub](https://github.com/ember-nexus/web-sdk), [our website ember-nexus.dev](https://ember-nexus.dev), and
[Discord](https://discord.gg/3UhupSvMAa).

## Features

Using the Web SDK provides multiple advantages over directly connecting to the API itself:
Expand All @@ -20,7 +28,7 @@ Using the Web SDK provides multiple advantages over directly connecting to the A
and bypassed for individual element lookups.
- **Events**: All API endpoints can be optionally exposed as browser events. This is especially useful for abstraction
and modularization; all official Ember Nexus apps do use these events extensively.
- **Type safety**: The SDK is written in Typescript and uses explicitly defined types all throughout.
- **Type safety**: The SDK is written in TypeScript and uses explicitly defined types all throughout.

## Planned Features

Expand Down

0 comments on commit a2b83ec

Please sign in to comment.