Skip to content

Commit 527ef53

Browse files
committed
Remove API docs from main README
1 parent 9dc8316 commit 527ef53

1 file changed

Lines changed: 4 additions & 44 deletions

File tree

README.md

Lines changed: 4 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,6 @@ A tide prediction engine written in TypeScript.
99
>
1010
> Do not use calculations from this project for navigation, or depend on them in any situation where inaccuracies could result in harm to a person or property. Tide predictions are only as good as the harmonics data available, and these can be inconsistent and vary widely based on the accuracy of the source data and local conditions. The tide predictions do not factor events such as storm surge, wind waves, uplift, tsunamis, or sadly, climate change. 😢
1111
12-
## Installation
13-
14-
```sh
15-
npm install neaps
16-
```
17-
18-
For the HTTP API:
19-
20-
```sh
21-
npm install @neaps/api express
22-
```
23-
2412
## Packages
2513

2614
This monorepo contains:
@@ -29,41 +17,13 @@ This monorepo contains:
2917
- **[@neaps/api](packages/api)** - HTTP JSON API for tide predictions with OpenAPI specification
3018
- **[@neaps/tide-predictor](packages/tide-predictor)** - Core harmonic tide prediction engine
3119

32-
## Usage
33-
34-
### HTTP API
35-
36-
The `@neaps/api` package provides a REST API for tide predictions:
37-
38-
```typescript
39-
import { createApp } from "@neaps/api";
40-
41-
// Create and start server
42-
const app = createApp();
43-
app.listen(3000, () => {
44-
console.log("API server listening on port 3000");
45-
});
46-
47-
// Or use as Express middleware
48-
import express from "express";
20+
## Installation
4921

50-
const mainApp = express();
51-
mainApp.use("/api", createApp());
52-
mainApp.listen(3000);
22+
```sh
23+
npm install neaps
5324
```
5425

55-
API endpoints:
56-
57-
- `GET /extremes` - Get high/low tide predictions for a location
58-
- `GET /timeline` - Get water level predictions at intervals
59-
- `GET /stations` - Find stations by ID or near coordinates
60-
- `GET /stations/:id/extremes` - Get extremes for a specific station
61-
- `GET /stations/:id/timeline` - Get timeline for a specific station
62-
- `GET /openapi.json` - OpenAPI 3.0 specification
63-
64-
See the [@neaps/api README](packages/api/README.md) for full documentation.
65-
66-
### JavaScript/TypeScript Library
26+
## Usage
6727

6828
### Tide Extremes Prediction
6929

0 commit comments

Comments
 (0)