Skip to content

Commit af6c13f

Browse files
committed
Update README.md
1 parent 8fa2e80 commit af6c13f

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ To make this all work seamlessly, we use [Narwhals](https://github.com/narwhals-
5959

6060
## Features
6161

62-
Here's a short list of what we think makes pointblank a great tool for data validation:
62+
Here's a short list of what we think makes Pointblank a great tool for data validation:
6363

6464
- **Declarative Syntax**: Define your data validation rules simply, using a declarative syntax
6565
- **Flexible**: We support tables from Polars, Pandas, Duckdb, MySQL, PostgreSQL, SQLite, and Parquet
@@ -69,9 +69,14 @@ Here's a short list of what we think makes pointblank a great tool for data vali
6969
- **Easy to Use**: Get started quickly with a simple API and super clear documentation
7070
- **Powerful**: You can develop complex data validation rules with flexible options for customization
7171

72+
There's a lot of [interesting examples](https://rich-iannone.github.io/pointblank/examples/) you can
73+
check out in the documentation website. If you have any questions or would like to request a
74+
feature, you are always welcome to [create an issue](https://github.com/rich-iannone/pointblank/issues)
75+
or [start a discussion](https://github.com/rich-iannone/pointblank/discussions)!
76+
7277
## Installation
7378

74-
You can install pointblank using pip:
79+
You can install Pointblank using pip:
7580

7681
```bash
7782
pip install pointblank
@@ -83,9 +88,9 @@ If you encounter a bug, have usage questions, or want to share ideas to make thi
8388

8489
Please note that the pointblank project is released with a [contributor code of conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).<br>By participating in this project you agree to abide by its terms.
8590

86-
## Contributing to pointblank
91+
## Contributing to Pointblank
8792

88-
There are many ways to contribute to the ongoing development of pointblank. Some contributions can be simple (like fixing typos, improving documentation, filing issues for feature requests or problems, etc.) and others might take more time and care (like answering questions and submitting PRs with code changes). Just know that anything you can do to help would be very much appreciated!
93+
There are many ways to contribute to the ongoing development of Pointblank. Some contributions can be simple (like fixing typos, improving documentation, filing issues for feature requests or problems, etc.) and others might take more time and care (like answering questions and submitting PRs with code changes). Just know that anything you can do to help would be very much appreciated!
8994

9095
Please read over the [contributing guidelines](https://github.com/rich-iannone/pointblank/blob/main/CONTRIBUTING.md) for information on how to get started.
9196

0 commit comments

Comments
 (0)