Skip to content

Commit

Permalink
Documentation update(typo fixes)
Browse files Browse the repository at this point in the history
  • Loading branch information
caraplana1 committed Aug 4, 2024
1 parent 11fb3aa commit 73ed0b9
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
12 changes: 6 additions & 6 deletions Docs/ClassDocs.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ List of class.

### Methods

* `CreateCBZ(string[] imagesPaths, string fileName)` <br/>
* `CreateCbz(string[] imagesPaths, string fileName)` <br/>
Creates zip file but with cbz extension

* `CreateCBT(string[] imagesPaths, string fileName)` <br/>
* `CreateCbt(string[] imagesPaths, string fileName)` <br/>
Creates Tar file but with cbt extension

* `CreatePdf(string[] imagesPaths, string fileName)` <br/>
Expand All @@ -62,7 +62,7 @@ Extract Jpeg from pdf file to a directory.

Enum for all comic format available.

`CBR`\
`CBZ`\
`CBT`\
`PDF`
`Cbr`\
`Cbz`\
`Cbt`\
`Pdf`
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# ComicConverter

A multi-plataform .NET library written in Net standard 2.0 for comic formating.
A multi-platform .NET library written in Net standard 2.0 for comic formating.

## Suported Formats
## Supported Formats

These are the comic formats that we currently support.

| Format | Extract Images | Create Comic |
| :----: | :------------: | :--------------: |
| CBR | ✔️ | |
| CBZ | ✔️ | ✔️ |
| CBT | ✔️ | ✔️ |
| PDF | :heavy_check_mark: | :heavy_check_mark: |
| Format | Extract Images | Create Comic |
|:------:|:------------------:|:------------------:|
| CBR | ✔️ | |
| CBZ | ✔️ | ✔️ |
| CBT | ✔️ | ✔️ |
| PDF | :heavy_check_mark: | :heavy_check_mark: |

We can't convert to CBR files due to RAR compression algorithm lincense.
We can't convert to CBR files due to RAR compression algorithm license.

## Samples

For start using the library just paste `using ComicConverter;` in your C# file and follow the next examples depending of what you want.\
For start using the library just paste `using ComicConverter;` in your C# file and follow the next examples depending on what you want.\
- **Note**:
**The final file result will append the file extension to the given name**

Expand All @@ -44,10 +44,10 @@ pdf.Convert("MyCbzComic", ComicFormat.CBZ);
```C#
string[] imagesPaths = {"Image1.png", "Folder/Image2.png"};

ComicBuilder.CreateCBZ(imagesPaths, "comicName");
ComicBuilder.CreateCbz(imagesPaths, "comicName");
```

- **Extract CBR's content to a folder.**
- **Extract Cbr content to a folder.**

```C#
string folder = "MyFolder";
Expand Down

0 comments on commit 73ed0b9

Please sign in to comment.