Merge pull request ferdikoomen#17 from nicolas-chaulet/docs/readme

docs(readme): explain the fork

Author: mrlubos

README.md

@@ -1,27 +1,38 @@
-# OpenAPI Typescript Codegen
+# Why The Fork?
 
-> Node.js library that generates Typescript clients based on the OpenAPI specification.
+Mainly, it's because the original project maintainer [doesn't have time](https://github.com/ferdikoomen/openapi-typescript-codegen/issues/1276#issuecomment-1302392146) to support the project. We wanted to keep the development going since this library became incompatible with [FastAPI v0.99.0 release](https://fastapi.tiangolo.com/release-notes/#0990) that introduced support for OpenAPI v3.1. While that was the main objective, this fork also offers other features such as:
 
-This Repo is a fork of the original codebase that was created to support OpenAPI spec v3.1. The original motivation was to be able to support schema generated by [FastAPI](https://fastapi.tiangolo.com/) versions 0.100 and above.
+- correct handling of 204 response status codes
+- ability to select which services to export and naming strategies for generated methods
+- support for non-ASCII characters
+- support for x-body-name header (compatible with Connexion v3.x)
 
+# OpenAPI Typescript Codegen
+
+> Node.js library that generates Typescript clients based on the OpenAPI specification.
 
 ## Why?
-- Frontend ❤️ OpenAPI, but we do not want to use JAVA codegen in our builds
+- Frontend ❤️ OpenAPI, but we do not want to use Java codegen in our builds
 - Quick, lightweight, robust and framework-agnostic 🚀
 - Supports generation of TypeScript clients
 - Supports generations of Fetch, Node-Fetch, Axios, Angular and XHR http clients
-- Supports OpenAPI specification v2.0 and v3.0
-- Partial support of OpenAPI specification v3.1
+- Supports OpenAPI specification v2.0 and v3.0 (v3.1 is partially supported)
 - Supports JSON and YAML files for input
-- Supports generation through CLI, Node.js and NPX
+- Supports generation through CLI, Node.js and npx
 - Supports tsc and @babel/plugin-transform-typescript
 - Supports aborting of requests (cancelable promise pattern)
 - Supports external references using [json-schema-ref-parser](https://github.com/APIDevTools/json-schema-ref-parser/)
 
 ## Install
 
 ```
-npm install openapi-typescript-codegen --save-dev
+npm install @nicolas-chaulet/openapi-typescript-codegen --save-dev
+```
+
+or
+
+```
+yarn add -D @nicolas-chaulet/openapi-typescript-codegen
 ```
 
 ## Usage
@@ -57,5 +68,5 @@ $ openapi --help
 Documentation
 ===
 
-The main documentation can be found in the [openapi-typescript-codegen/wiki](https://github.com/ferdikoomen/openapi-typescript-codegen/wiki)
+The original documentation can be found in the [openapi-typescript-codegen/wiki](https://github.com/ferdikoomen/openapi-typescript-codegen/wiki)