Skip to content

Commit

Permalink
Merge pull request #9 from dojyorin/dev
Browse files Browse the repository at this point in the history
fix version.
  • Loading branch information
dojyorin authored May 10, 2023
2 parents 59c7781 + cf1ac1a commit 684d5ea
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
![actions:test](https://github.com/dojyorin/arduino_base64/actions/workflows/test.yaml/badge.svg)
![actions:release](https://github.com/dojyorin/arduino_base64/actions/workflows/release.yaml/badge.svg)

Convert between binary and Base64.
Convert between binary and Base64 encoded string.
Easily convert sensor raw values, structures, etc.

# Example
Expand All @@ -27,7 +27,7 @@ base64::decode(data, result);
The only export of this library will be [`arduino_base64.hpp`](./src/arduino_base64.hpp).
Other source files are for internal use and should not normally be include.

This is library made to convert binary data (e.g. raw sensor values) to Base64.
This is library made to convert binary data (e.g. raw sensor values) to Base64 encoded string.
String can be convert by cast them to byte arrays, but that's not what this library is for, nor do we plan to provide a means.
If you want to convert string, use this library and implement the wrapper functions yourself.

Expand Down
4 changes: 2 additions & 2 deletions library.properties
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name=base64_encode
author=dojyorin
version=3.0.0
version=2.0.0
architectures=*
includes=arduino_base64.hpp
sentence=Convert between binary and Base64.
sentence=Convert between binary and Base64 encoded string.
paragraph=Easily convert sensor raw values, structures, etc.
category=Other
maintainer=https://github.com/dojyorin
Expand Down
6 changes: 3 additions & 3 deletions src/arduino_base64.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
#include "string.h"

/**
* Convert between binary and Base64.
* Convert between binary and Base64 encoded string.
* @see https://github.com/dojyorin/arduino_base64
*/
namespace base64{
/**
* Convert binary to Base64.
* Convert binary to Base64 encoded string.
* If the input is string, cast it to `uint8_t*`.
* @param input Binary data.
* @param inputLength Number of input bytes.
Expand All @@ -25,7 +25,7 @@ namespace base64{
size_t encodeLength(size_t inputLength);

/**
* Convert Base64 to binary.
* Convert Base64 encoded string to binary.
* If the output is string, cast it to `char*`.
* @param input Base64 encoded string.
* @param output Binary data.
Expand Down

0 comments on commit 684d5ea

Please sign in to comment.