Merge pull request #15 from ridvanaltun/next

Next

Author: ridvanaltun

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit "$1"

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run pre-commit

README.md

@@ -1,3 +1,4 @@
+<!-- omit in toc -->
 # 🍋 Unofficial Ek$i Sozluk Client for Node.js
 
 [![npm version](https://img.shields.io/npm/v/eksi-sozluk.svg)](https://npmjs.com/package/eksi-sozluk)
@@ -10,19 +11,32 @@
 
 > **This library help you to conquer the Eksi Sozluk in Node.js.**
 
-## Installation
+<!-- omit in toc -->
+# Table of Contents
+
+- [Installation](#installation)
+- [Documentation](#documentation)
+  - [Tutorials](#tutorials)
+- [Development](#development)
+  - [Commit Messages](#commit-messages)
+  - [Code Quality](#code-quality)
+  - [Available Scripts](#available-scripts)
+- [Special Thanks](#special-thanks)
+- [License](#license)
+
+# Installation
 
 ```bash
 npm install eksi-sozluk --save
 ```
 
-## Documentation
+# Documentation
 
 Technical documentation is automatically created with [JSDoc](https://github.com/jsdoc/jsdoc) after each new release.
 
 [You can find the technical documentation here!](https://ridvanaltun.github.io/eksi-sozluk/)
 
-### Tutorials
+## Tutorials
 
 **IMPORTANT:** The tutorials are not fully covered for all use cases and its not mention all capabilities of the library, don't forget to check technical documentation if you didn't found anything you looking for.
 
@@ -38,7 +52,7 @@ Technical documentation is automatically created with [JSDoc](https://github.com
 - [Questions](https://ridvanaltun.github.io/eksi-sozluk/tutorial-10-questions.html)
 - [Miscellaneous](https://ridvanaltun.github.io/eksi-sozluk/tutorial-11-miscellaneous.html)
 
-## Development
+# Development
 
 ```bash
 # clone the repository
@@ -50,23 +64,23 @@ cd eksi-sozluk & npm i
 
 After these steps you can change the code. If you want test your changes; go to `__tests__` folder, find a proper test file or create one if necessary. if the test pass, ensure your code quality and write documentation. All after you are ready to send a PR.
 
-Check [scripts](#npm-scripts) section to learn how to run tests and linter (for [code quality](#code-quality)).
+Check [scripts](#available-scripts) section to learn how to run tests and linter (for [code quality](#code-quality)).
 
-### Commit Messages
+## Commit Messages
 
 Every commit message must be `conventional commits` format.
 
 [What is Conventional Commits?](https://www.conventionalcommits.org/en/v1.0.0/#summary)
 
 If you don't have a time just use `npm run commit` command instead of use Git.
 
-### Code Quality
+## Code Quality
 
-Keeping code quality as good is a hard job in normally. Therefore, we are using EsLint (linter) and Prettier to keep and track the code quality. Not linted pull requests automatically deny from via Travis (CI/CD). You can lint your code using [scripts](#npm-scripts) section.
+Keeping code quality as good is a hard job in normally. Therefore, we are using EsLint (linter) and Prettier to keep and track the code quality. Not linted pull requests automatically deny from via Travis (CI/CD). You can lint your code using [scripts](#available-scripts) section.
 
 In short, run `npm run lint` command.
 
-### NPM Scripts
+## Available Scripts
 
 ```bash
 # commit your changes with commitizen
@@ -94,10 +108,10 @@ npm run semantic-release
 npm run docs
 ```
 
-## Special Thanks
+# Special Thanks
 
 I would like to thank [@kucukkanat](https://github.com/kucukkanat) the owner original `eksi-sozluk` package for transferring the package's rights to me. The old package was in security holding status, nobody was using it.
 
-## License
+# License
 
 [GNU General Public License v3.0](https://github.com/ridvanaltun/eksi-sozluk/blob/master/LICENSE)