Skip to content

Commit

Permalink
doc(readme): add basic info about the validator
Browse files Browse the repository at this point in the history
Signed-off-by: Jefersson Nathan <[email protected]>
  • Loading branch information
malukenho committed Jun 27, 2023
1 parent 64e4872 commit fe342dc
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
📚 Xulieta - SQL Validator
==========================

> **Warning**
> This library is highly experimental.
#### 📊 SQL Validator?

Yes, you read it right. This packages provides basic SQL validation for.
your code snippets Just plug it in your xulieta configuration and you
are good to go.

```shell script
composer require codelicia/xulieta-sql-validator --dev
```

Xulieta will automatically detect the validator and will configure it
for you. You can check it out on you `.xulieta.xml` file.

---

### Checking for errors

After registering the validator, no extra steps are required. Just run
xulieta as usual.

```shell script
./vendor/bin/xulieta check:erromeu <directory>
```

### How to use it on my docs?

Just make sure you mark you code block as `sql`, `mysql` or
`postgresql` and you are good to go If you'd like to add something
else, please open an issue or a PR.
## Author 🎩✨
- malukenho (@malukenho)
- Eher (@EHER)

0 comments on commit fe342dc

Please sign in to comment.