first CRAN release

DESCRIPTION

@@ -1,12 +1,13 @@
 Package: qoi
 Type: Package
-Title: Read And Write QOI Images
+Title: Read and Write QOI Images
+Date: 2022-04-15
 Version: 0.0.1
 Authors@R: person("Johannes", "Friedrich", role = c("aut", "cre"), email = "[email protected]")
 Maintainer: Johannes Friedrich <[email protected]>
 URL: https://github.com/JohannesFriedrich/qoi4R
 BugReports: https://github.com/JohannesFriedrich/qoi4R/issues
-Description: This package provides an easy and simple way to read, write and display bitmap images stored in the QOI (Quite Ok Image) format. It can read and write both files and in-memory raw vectors.
+Description: The new QOI file format offers a very simple but efficient image compression algorithm. This package provides an easy and simple way to read, write and display bitmap images stored in the QOI (Quite Ok Image) format. It can read and write both files and in-memory raw vectors.
 License: GPL (>= 3)
 Encoding: UTF-8
 NeedsCompilation: yes

Readme.Rmd

@@ -44,6 +44,7 @@ devtools::install_github("JohannesFriedrich/qoi4R")
 ## Usage
 
 There are just two main functions: `readQOI()` and `writeQOI()`.
+
 * `readQOI()`: Takes an qoi-format image and decodes it into its RGB or RGBA values. The result is a matrix with dimensions height x width x channels.
 * `writeQOI()`: Takes an RGB(A) matrix and encodes it into an qoi-image.
 

Readme.md

@@ -33,11 +33,13 @@ devtools::install_github("JohannesFriedrich/qoi4R")
 
 ## Usage
 
-There are just two main functions: `readQOI()` and `writeQOI()`. \*
-`readQOI()`: Takes an qoi-format image and decodes it into its RGB or
-RGBA values. The result is a matrix with dimensions height x width x
-channels. \* `writeQOI()`: Takes an RGB(A) matrix and encodes it into an
-qoi-image.
+There are just two main functions: `readQOI()` and `writeQOI()`.
+
+- `readQOI()`: Takes an qoi-format image and decodes it into its RGB
+ or RGBA values. The result is a matrix with dimensions height x
+ width x channels.
+- `writeQOI()`: Takes an RGB(A) matrix and encodes it into an
+ qoi-image.
 
 ### `readQOI()`
 
@@ -116,3 +118,17 @@ file <- file("file.qoi", "wb")
 writeQOI(qoi_logo_rgb_qoi, file)
 close(file)
 ```
+
+## Acknowlegment
+
+This package would not exist without the following
+persons/homepages/tutorial/…:
+
+- [Phoboslab - original
+ specification](https://github.com/phoboslab/qoi)
+- [PNG R-package](https://github.com/s-u/png)
+- [Example C-code
+ R-package](https://github.com/coolbutuseless/simplecall)
+- [R
+ extensions](https://cran.r-project.org/doc/manuals/r-release/R-exts.html)
+- [Hadley´s R-Internals](https://github.com/hadley/r-internals)