diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index aeb19ef54..01fc970a6 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -32,7 +32,7 @@ jobs: run: ./gradlew aggregatedJavadocs - name: Deploy JavaDocs - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./build/docs diff --git a/README.md b/README.md index 15bf169c3..262450005 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,9 @@ -# NewPipe Extractor - -[![CI](https://github.com/TeamNewPipe/NewPipeExtractor/actions/workflows/ci.yml/badge.svg?branch=dev&event=schedule)](https://github.com/TeamNewPipe/NewPipeExtractor/actions/workflows/ci.yml) [![JIT Pack Badge](https://jitpack.io/v/TeamNewPipe/NewPipeExtractor.svg)](https://jitpack.io/#TeamNewPipe/NewPipeExtractor) [JDoc](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/) • [Documentation](https://teamnewpipe.github.io/documentation/) - -NewPipe Extractor is a library for extracting things from streaming sites. It is a core component of [NewPipe](https://github.com/TeamNewPipe/NewPipe), but could be used independently. - -## Usage - -NewPipe Extractor is available at JitPack's Maven repo. - -If you're using Gradle, you could add NewPipe Extractor as a dependency with the following steps: - -1. Add `maven { url 'https://jitpack.io' }` to the `repositories` in your `build.gradle`. -2. Add `implementation 'com.github.TeamNewPipe:NewPipeExtractor:INSERT_VERSION_HERE'` to the `dependencies` in your `build.gradle`. Replace `INSERT_VERSION_HERE` with the [latest release](https://github.com/TeamNewPipe/NewPipeExtractor/releases/latest). -3. If you are using tools to minimize your project, make sure to keep the files below, by e.g. adding the following lines to your proguard file: - ``` -## Rules for NewPipeExtractor --keep class org.schabi.newpipe.extractor.timeago.patterns.** { *; } --keep class org.mozilla.javascript.** { *; } --keep class org.mozilla.classfile.ClassFileWriter --dontwarn org.mozilla.javascript.tools.** -``` - -**Note:** To use NewPipe Extractor in Android projects with a `minSdk` below 26, [API desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring) is required. If the `minSdk` is below 19, the `desugar_jdk_libs_nio` artifact is required, which requires Android Gradle Plugin (AGP) version 7.4.0. - -### Testing changes - -To test changes quickly you can build the library locally. A good approach would be to add something like the following to your `settings.gradle`: - -```groovy -includeBuild('../NewPipeExtractor') { - dependencySubstitution { - substitute module('com.github.TeamNewPipe:NewPipeExtractor') with project(':extractor') - } -} -``` - -Another approach would be to use the local Maven repository, here's a gist of how to use it: - -1. Add `mavenLocal()` in your project `repositories` list (usually as the first entry to give priority above the others). -2. It's _recommended_ that you change the `version` of this library (e.g. `LOCAL_SNAPSHOT`). -3. Run gradle's `ìnstall` task to deploy this library to your local repository (using the wrapper, present in the root of this project: `./gradlew install`) -4. Change the dependency version used in your project to match the one you chose in step 2 (`implementation 'com.github.TeamNewPipe:NewPipeExtractor:LOCAL_SNAPSHOT'`) - -> Tip for Android Studio users: After you make changes and run the `install` task, use the menu option `File → "Sync with File System"` to refresh the library in your project. - -## Supported sites +# Last Pipe Extractor +### Supported Sites The following sites are currently supported: - - YouTube - SoundCloud - media.ccc.de - PeerTube (no P2P) -- Bandcamp - -## License - -[![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](https://www.gnu.org/licenses/gpl-3.0.en.html) - -NewPipe Extractor is Free Software: You can use, study share and improve it at your -will. Specifically you can redistribute and/or modify it under the terms of the -[GNU General Public License](https://www.gnu.org/licenses/gpl.html) as -published by the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. +- Bandcamp \ No newline at end of file