Skip to content

Commit

Permalink
docs(readme): fix highlighted quotes syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
jhdcruz committed Jul 27, 2023
1 parent 01baf1e commit 1f64858
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 9 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Minimum requirements to use the library:
- Kotlin 1.7+
- Java 8+

> **Note**
> [!NOTE]
>
> If your project uses earlier JDK 8, you might need
> [Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files](https://www.oracle.com/java/technologies/javase-jce-all-downloads.html)
Expand Down Expand Up @@ -120,7 +120,7 @@ dependencies {
</project>
```

> **Warning**
> [!WARNING]
>
> Snapshots should be considered unstable and contain breaking changes,
> they are primarily for testing purposes.
Expand All @@ -143,6 +143,7 @@ dependencies {
- [IntelliJ IDEA](https://www.jetbrains.com/help/idea/library.html#define-library)
- [Netbeans](https://stackoverflow.com/questions/4879903/how-to-add-a-jar-in-netbeans)

> [!IMPORTANT]
> This method doesn't include all the necessary dependencies.
>
> Although, the errors will tell you the dependencies you need.
Expand Down Expand Up @@ -243,7 +244,7 @@ class EncryptionTest {

Default security provider is set to [Bouncy Castle](https://bouncycastle.org/).

> **Note**
> [!NOTE]
>
> Changing provider has to be done **before** using any of the library
> functions/methods.
Expand Down Expand Up @@ -343,7 +344,7 @@ class Main {
}
```

> **Warning**
> [!WARNING]
>
> `provider` value is tied to the class itself, keep in mind when using the library
> functions/methods in parallel with different providers.
Expand All @@ -360,7 +361,7 @@ The library will follow semantic versioning where every breaking changes bumps t
regardless of how small the change is, this way developers know that something will not work should
they update.

> **Note**
> [!NOTE]
>
> Each modules are independently versioned to avoid version bumps between unrelated module/s.
Expand All @@ -378,7 +379,9 @@ details

## Disclaimer

**I** ([@jhdcruz](https://github.com/jhdcruz)) **am not a security expert/professional**.
> [!IMPORTANT]
>
> **I** ([@jhdcruz](https://github.com/jhdcruz)) **am not a security expert/professional**.
This library is primarily made for convenience and ease-of-use,
while providing as much security as possible out-of-the-box.
Expand Down
2 changes: 1 addition & 1 deletion kipher-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Core utility libraries used by kipher modules.

> **Note**
> [!NOTE]
>
> Already bundled in all kipher modules.
Expand Down
2 changes: 1 addition & 1 deletion kipher-digest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Library for cryptographic hash functions (such as SHAs, MD5s).

## Adding Dependency

> **Note**
> [!NOTE]
>
> Currently only available in snapshot version.
Expand Down
2 changes: 1 addition & 1 deletion kipher-mac/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Library for ensuring data integrity and authenticity using message authenticatio

## Adding Dependency

> **Note**
> [!NOTE]
>
> Currently only available in snapshot version.
Expand Down

0 comments on commit 1f64858

Please sign in to comment.