Skip to content

Commit

Permalink
change: relative header path.
Browse files Browse the repository at this point in the history
  • Loading branch information
dojyorin committed Oct 30, 2020
1 parent 739ebff commit a3a57b6
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 9 deletions.
7 changes: 0 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Arduino Base64 Codec
Binary based simple Base64 Codec for Arduino.


# Example
## Encode
```c++
Expand All @@ -14,7 +13,6 @@ BASE64::encode((const uint8_t*)rawData, rawLength, encoded);
Serial.println(encoded);
```
## Decode
```c++
const char* encoded = "Zm9vYmFy";
Expand All @@ -25,7 +23,6 @@ BASE64::decode(encoded, raw);
Serial.println((char*)raw);
```


# API
## void BASE64::encode(const uint8_t* input, size_t inputLength, char* output)
**Arguments**
Expand All @@ -39,15 +36,13 @@ Serial.println((char*)raw);
**Note**
- If the input data is `char*` string, cast it to `uint8_t*`.


## size_t BASE64::encodeLength(size_t inputLength)
**Arguments**
- `inputLength`: Number of bytes of input data.

**Return**
- Number of characters after Base64 encoding.


## void BASE64::decode(const char* input, uint8_t* output)
**Arguments**
- `input`: Receives string data as a base64 encoded.
Expand All @@ -59,14 +54,12 @@ Serial.println((char*)raw);
**Note**
- If the output data is string, you can cast it to `char*`.


## size_t BASE64::decodeLength(const char* input)
**Arguments**
- `input`: Receives string data as a base64 encoded.

**Return**
- Number of bytes after Base64 decoding.


# Disclaimer
According to MIT License.
2 changes: 1 addition & 1 deletion library.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name=Base64_Codec
version=1.0.4
version=1.0.5
author=dojyorin
maintainer=https://github.com/dojyorin
sentence=Base64 Codec
Expand Down
2 changes: 1 addition & 1 deletion src/Base64.cpp
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#include "Base64.h"
#include "./Base64.h"

namespace{
constexpr char alphaTable[64] = {
Expand Down

0 comments on commit a3a57b6

Please sign in to comment.