Skip to content

Commit

Permalink
Update README for dropping misskey
Browse files Browse the repository at this point in the history
  • Loading branch information
h3poteto committed Sep 21, 2023
1 parent a9889ab commit ff3cd72
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
[![NPM](https://img.shields.io/npm/l/megalodon)](/LICENSE.txt)

A Fediverse API Client library for node.js and browser. It provides REST API and streaming methods.
By using this library, you can take Mastodon, Pleroma, Friendica, and Misskey with the same interface.
By using this library, you can take Mastodon, Pleroma, Friendica, and Firefish with the same interface.

The Rust version is [megalodon-rs](https://github.com/h3poteto/megalodon-rs).

## Supporting
- [x] Mastodon
- [x] Pleroma
- [x] Friendica
- [x] Misskey
- [x] Firefish
- [x] Akkoma (Unofficial)
- [x] Widlebeest (Unofficial)

Expand Down Expand Up @@ -103,7 +103,6 @@ client.uploadMedia(image)
```

### WebSocket streaming
Mastodon, Pleroma and Misskey provide WebSocket for streaming.

```typescript
import generator, { Entity, WebSocketInterface } from 'megalodon'
Expand Down Expand Up @@ -188,13 +187,13 @@ client.fetchAccessToken(clientId, clientSecret, code)
```

### Detect each SNS
You have to provide SNS name `mastodon`, `pleroma` or `misskey` to `generator` function.
You have to provide SNS name (e.g. `mastodon`, `pleroma`) to `generator` function.
But when you only know the URL and not the SNS, `detector` function can detect the SNS.

```typescript
import { detector } from 'megalodon'

const URL = 'https://misskey.io'
const URL = 'https://mastodon.social'

const sns = await detector(URL)
console.log(sns)
Expand Down

0 comments on commit ff3cd72

Please sign in to comment.