Browse Source

Add README

master
Jan-Lukas Else 11 months ago
parent
commit
ad28c3515c
3 changed files with 33 additions and 1 deletions
  1. +21
    -0
      LICENSE
  2. +11
    -0
      README.md
  3. +1
    -1
      index.js

+ 21
- 0
LICENSE View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2020 Jan-Lukas Else
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

+ 11
- 0
README.md View File

@ -0,0 +1,11 @@
# TikTok to JSON Feed
This is a small tool, that let's you subscribe to TikTok users using [JSON Feed](https://jsonfeed.org/). It's using the library [tiktok-scraper](https://www.npmjs.com/package/tiktok-scraper).
## Usage
To retrieve the JSON Feed for a TikTok user, open the path "/users/" + username. It will return a feed with the 10 most recent videos. A URL to the video source is directly attached to each feed item.
## License
TikTokJsonFeed is licensed under the MIT license, so you can do basically everything with it, but nevertheless, please contribute your improvements to make this tool better for everyone. See the LICENSE file.

+ 1
- 1
index.js View File

@ -1,5 +1,5 @@
const express = require('express')
const scraper = require('tiktok-scraper');
const scraper = require('tiktok-scraper')
const app = express()
const port = 8080


Loading…
Cancel
Save