From fcae7afda09f64c35d17985722012eae4cd911ba Mon Sep 17 00:00:00 2001 From: Denys Dorokhov Date: Mon, 15 Feb 2021 16:54:37 +0100 Subject: [PATCH 1/2] README.md in the project root created --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2fde9eb --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# 🧨🔥 Flares - Highly customizable Typescript status code library + + +## Integrations +- [Express](https://github.com/vaderkos/flares/tree/develop/packages/express) + +## Installation +Choose your favorite naming convention from: +* [Pascal case](https://www.npmjs.com/package/@flares/pascal-case-flares) +```typescript +throw new Fls.BadRequest('Error happened') +// or +return Fls.BadRequest('Error happened') +``` +* [Pascal case with code](https://www.npmjs.com/package/@flares/pascal-case-code-flares) +```typescript +throw new Fls.BadRequest400('Error happened') +// or +return Fls.BadRequest400('Error happened') +``` +* [Camel case](https://www.npmjs.com/package/@flares/camel-case-flares) +```typescript +throw new Fls.badRequest('Error happened') +// or +return Fls.badRequest('Error happened') +``` +* [Camel case with code](https://www.npmjs.com/package/@flares/camel-case-code-flares) +```typescript +throw new Fls.badRequest400('Error happened') +// or +return Fls.badRequest400('Error happened') +``` + + +You can also write your own implementation using [`@flares/core` module](https://github.com/vaderkos/flares/tree/develop/packages/core) From ac6c5e01dbd7b9cd62333d581727f45f5521d7c1 Mon Sep 17 00:00:00 2001 From: hamboomger Date: Mon, 15 Feb 2021 16:58:20 +0100 Subject: [PATCH 2/2] feat(readme): typescript prerequisite added --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 2fde9eb..52bebfd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # 🧨🔥 Flares - Highly customizable Typescript status code library +## Prerequisites +- `Typescript >= 4.0` ## Integrations - [Express](https://github.com/vaderkos/flares/tree/develop/packages/express)