Skip to content

Commit

Permalink
docs(README): improved readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MarvinJWendt committed Apr 2, 2023
1 parent 42a1408 commit b7f6601
Showing 1 changed file with 17 additions and 15 deletions.
32 changes: 17 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,21 +74,6 @@ Make sure to run this command inside your project, when you're using go modules
go get github.com/pterm/pterm
```

If you want to create a CLI tool, make sure to check out our [cli-template](https://github.com/pterm/cli-template),
which features automatic website generation, automatic deployments, a custom CI-System and much more!

## ⭐ Main Features

|Feature|Description|
|-------|-----------|
|πŸͺ€ Easy to use |Our first priority is to keep PTerm as easy to use as possible.<br> With many [examples](#-examples) for each individual component, getting started with PTerm is extremely easy.<br> All components are similar in design and implement interfaces to simplify mixing individual components together.|
|πŸ€Ήβ€β™€οΈ Cross-Platform |We take special precautions to ensure that PTerm works on as many operating systems and terminals as possible.<br> Whether it's `Windows CMD`, `macOS iTerm2` or in the backend (for example inside a `GitHub Action` or other CI systems), PTerm **guarantees** beautiful output!|
|πŸ§ͺ Well tested |PTerm has a 100% test coverage, which means that every line of code inside PTerm gets tested automatically<br>We test PTerm continuously. However, since a human cannot test everything all the time, we have our own test system with which we currently run <!-- unittestcount2:start -->**`28774`**<!-- unittestcount2:end -->automated tests to ensure that PTerm has no bugs. |
|✨ Consistent Colors|PTerm uses the [ANSI color scheme](https://en.wikipedia.org/wiki/ANSI_escape_code#3/4_bit) which is widely used by terminals to ensure consistent colors in different terminal themes.<br>If that's not enough, PTerm can be used to access the full RGB color scheme (16 million colors) in terminals that support `TrueColor`.|
|πŸ“š Component system|PTerm consists of many components, called `Printers`, which can be used individually or together to generate pretty console output.|
|πŸ›  Configurable|PTerm can be used by without any configuration. However, you can easily configure each component with little code, so everyone has the freedom to design their own terminal output.|
|✏ Documentation |To view the official documentation of the latest release, you can go to the automatically generated page of [pkg.go.dev](https://pkg.go.dev/github.com/pterm/pterm#section-documentation) This documentation is very technical and includes every method that can be used in PTerm.<br>**For an easy start we recommend that you take a look at the [examples section](#-examples).** Here you can see pretty much every feature of PTerm with example code. The animations of the examples are automatically updated as soon as something changes in PTerm.|

<div align="center">

### Printers (Components)
Expand All @@ -107,6 +92,23 @@ which features automatic website generation, automatic deployments, a custom CI-
|Prefixes|[Examples](https://github.com/pterm/pterm/tree/master/_examples/prefix)|-|||
|Progress Bars|[Examples](https://github.com/pterm/pterm/tree/master/_examples/progressbar)|-|||

</div>

## ⭐ Main Features

| Feature | Description |
|------------------|-----------------------------------------------------|
| πŸͺ€ Easy to use | PTerm emphasizes ease of use, with [examples](#-examples) and consistent component design. |
| πŸ€Ήβ€β™€οΈ Cross-Platform | PTerm works on various OS and terminals, including `Windows CMD`, `macOS iTerm2`, and in CI systems like `GitHub Actions`. |
| πŸ§ͺ Well tested | A high test coverage and <!-- unittestcount2:start -->`28774`<!-- unittestcount2:end --> automated tests ensure PTerm's reliability. |
| ✨ Consistent Colors | PTerm uses the [ANSI color scheme](https://en.wikipedia.org/wiki/ANSI_escape_code#3/4_bit) for uniformity and supports `TrueColor` for advanced terminals. |
| πŸ“š Component system | PTerm's flexible `Printers` can be used individually or combined to generate beautiful console output. |
| πŸ›  Configurable | PTerm is ready to use without configuration but allows easy customization for unique terminal output. |
| ✏ Documentation | Access comprehensive docs on [pkg.go.dev](https://pkg.go.dev/github.com/pterm/pterm#section-documentation) and view practical examples in the [examples section](#-examples). |


<div align="center">

### πŸ¦Έβ€β™‚οΈ Supporters

|-|User|πŸ’Έ|
Expand Down

0 comments on commit b7f6601

Please sign in to comment.