Skip to content

Commit

Permalink
remove explicit library type, update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
LeadRDRK committed Aug 26, 2020
1 parent 74eaae8 commit 8002648
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Designed to be extremely fast, it exclusively uses the Zstandard compression alg

More about Zstandard/zstd at https://facebook.github.io/zstd
# Status
ZPack is still a relatively new format. Its implementation is also only recently developed, therefore the API is not perfect yet but it's already fully functional and can be used in your own projects.
ZPack is still a relatively new format. Its implementation is also only recently developed, therefore the API is not perfect yet but it's already fully functional and can be used in your own projects. However, it should not be considered as stable and API changes can be made at any time. Be mindful when upgrading to a newer version.
# Documentation
The specifications for the ZPack file format can be found [here](docs/specs.txt)

Expand All @@ -17,4 +17,4 @@ You can build both the library and the CLI using the CMake file in the root dire

To include the library in your own project, add the /lib directory as a subdirectory in your own CMake file.
# License
ZPack is licensed under the [BSD 3-Clause license](LICENSE)
ZPack is licensed under the [BSD 3-Clause license](LICENSE)
2 changes: 1 addition & 1 deletion lib/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/../cmake")
find_package(ZSTD REQUIRED)

add_library(zpack SHARED
add_library(zpack
reader.cpp
unpacker.cpp
writer.cpp
Expand Down

0 comments on commit 8002648

Please sign in to comment.