Skip to content

Commit 154a715

Browse files
committed
Docs
1 parent 82d9dde commit 154a715

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
# @cap-js-community/websocket
1+
# WebSocket Adapter for CDS
22

33
[![npm version](https://img.shields.io/npm/v/@cap-js-community/websocket)](https://www.npmjs.com/package/@cap-js-community/websocket)
44
[![monthly downloads](https://img.shields.io/npm/dm/@cap-js-community/websocket)](https://www.npmjs.com/package/@cap-js-community/websocket)
55
[![REUSE status](https://api.reuse.software/badge/github.com/cap-js-community/websocket)](https://api.reuse.software/info/github.com/cap-js-community/websocket)
66
[![Main CI](https://github.com/cap-js-community/websocket/actions/workflows/main-ci.yml/badge.svg)](https://github.com/cap-js-community/websocket/commits/main)
77

8-
### [WebSocket Adapter for CDS](https://www.npmjs.com/package/@cap-js-community/websocket)
8+
## About this Project
99

1010
> Exposes a WebSocket protocol via WebSocket standard or Socket.IO for CDS services.
1111
> Runs in context of the [SAP Cloud Application Programming Model (CAP)](https://cap.cloud.sap/docs/)
1212
> using [@sap/cds](https://www.npmjs.com/package/@sap/cds) (CDS Node.js).
1313
1414
## Table of Contents
1515

16-
- [Getting Started](#getting-started)
16+
- [Requirements and Setup](#requirements-and-setup)
1717
- [Usage](#usage)
1818
- [Server](#server)
1919
- [Client](#client)
@@ -66,7 +66,7 @@
6666
- [Code of Conduct](#code-of-conduct)
6767
- [Licensing](#licensing)
6868

69-
## Getting Started
69+
## Requirements and Setup
7070

7171
- Run `npm add @cap-js-community/websocket` in `@sap/cds` project
7272
- Add a WebSocket enabled CDS service:

0 commit comments

Comments
 (0)