zotan/megalodon
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Add detector example for README

Browse source
This commit is contained in:
AkiraFukushima 2020-03-20 00:24:52 +09:00
parent 1b99cef6f1
commit dbdfd089f8
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -226,6 +226,19 @@ client.fetchAccessToken(clientId, clientSecret, code)
.catch((err: Error) => console.error(err))
```
### Detect each SNS
You have to provide SNS name `mastodon`, `pleroma` or `misskey` 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 sns = await detector(URL)
console.log(sns)
```
## License
The software is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).