Skip to content

Commit

Permalink
chore: Reorganized README and preparing for 1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
vemilyus committed May 10, 2024
1 parent 99eae23 commit 8ed8cab
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,18 @@ implementation("io.v47.jaffree:jaffree:$jaffreeVersion")
</dependency>
```

## Compatibility

Jaffree has been tested and verified to work with FFmpeg 4 until 6. It should also work with other
versions but your mileage may vary.

Tested to work on Windows, macOS (Intel & Apple Silicon), and Linux.

## Dependencies

- JDK 11
- FFmpeg 4+

## History

Inspired by [ffmpeg-cli-wrapper][ffmpeg-cli-wrapper].
Expand All @@ -41,7 +53,7 @@ outlook that tries to maintain 99% API compatibility with the original.

[jaffree]: https://github.com/kokorin/Jaffree

## Differences to Kokorin's library
### Differences to Kokorin's library

- Revamped process execution using different method of launching processes
- No more puller threads for process stdout and stderr (handled by NuProcess)
Expand All @@ -52,18 +64,6 @@ outlook that tries to maintain 99% API compatibility with the original.
- New code is written in Kotlin instead of Java for more robustness and better maintainability
- JDK support starts at 11 (dropped support for Java 1.8)

## Compatibility

Jaffree has been tested and verified to work with FFmpeg 4 until 6. It should also work with other
versions but your mileage may vary.

Tested to work on Windows, macOS (Intel & Apple Silicon), and Linux.

## Dependencies

- JDK 11
- FFmpeg 4+

## License

All existing code previous to the fork remains available under the Apache License Version 2.
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
group=io.v47.jaffree
version=0.14.3-SNAPSHOT
version=1.0.0-SNAPSHOT

0 comments on commit 8ed8cab

Please sign in to comment.