From 95e93d70a0ee1bc4c119074c6712a75dba22c84a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christoph=20N=C3=B6lke?= <connium@users.noreply.github.com>
Date: Thu, 9 May 2019 20:45:28 +0200
Subject: [PATCH] chore: improve repository structure (#72)

Move the `jsdoc2md` folder into the new `/tools` directory and extend the README.
---
 .npmignore                                   |  2 +-
 CHANGELOG.md                                 |  3 ++
 README.md                                    | 36 ++++++++++++++++++--
 package.json                                 |  2 +-
 {jsdoc2md => tools/jsdoc2md}/body.hbs        |  0
 {jsdoc2md => tools/jsdoc2md}/params-list.hbs |  0
 {jsdoc2md => tools/jsdoc2md}/returns.hbs     |  0
 {jsdoc2md => tools/jsdoc2md}/scope.hbs       |  0
 8 files changed, 38 insertions(+), 5 deletions(-)
 rename {jsdoc2md => tools/jsdoc2md}/body.hbs (100%)
 rename {jsdoc2md => tools/jsdoc2md}/params-list.hbs (100%)
 rename {jsdoc2md => tools/jsdoc2md}/returns.hbs (100%)
 rename {jsdoc2md => tools/jsdoc2md}/scope.hbs (100%)

diff --git a/.npmignore b/.npmignore
index 73ce063f..ee221869 100644
--- a/.npmignore
+++ b/.npmignore
@@ -3,10 +3,10 @@
 coverage/
 docs/
 examples/
-jsdoc2md/
 lib/test/
 src/
 test/
+tools/
 
 .bettercodehub.yml
 .travis.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 88cc9199..659c4546 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -11,6 +11,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - **style:** add common styles
 - **docs:** add a realistic example
 
+### Changed
+- **chore:** improve repository structure
+
 ## [0.8.0] (2019-02-26)
 ### Added
 - **font:** extend font declaration
diff --git a/README.md b/README.md
index e0f332e0..fd835c6c 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # simple-odf 
 
-Open Document Format made easy using pure JavaScript and Node.js
+simple-odf is a library for creating Open Document Format text files using Typescript/JavaScript and Node.js.
 
 [![Build Status](https://travis-ci.com/connium/simple-odf.svg?branch=master)](https://travis-ci.com/connium/simple-odf)
 [![Version](https://img.shields.io/npm/v/simple-odf.svg)](https://www.npmjs.com/package/simple-odf)
@@ -9,8 +9,26 @@ Open Document Format made easy using pure JavaScript and Node.js
 [![Known Vulnerabilities](https://snyk.io/test/github/connium/simple-odf/badge.svg)](https://snyk.io/test/github/connium/simple-odf)
 [![Standard - JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
+## Table of Contents
+
+- [Getting Started](#getting-started)
+  - [Prerequisites](#prerequisites)
+  - [Installing](#installing)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+  - [Pull Requests](#pull-requests)
+- [Versioning](#versioning)
+- [Credits](#credits)
+- [License](#license)
+
 ## Getting Started
 
+### Prerequisites
+
+Before you begin, make sure your development environment includes Node.js and an npm package manager.
+
+### Installing
+
 Install simple-odf using [`npm`](https://www.npmjs.com/):
 
 ```
@@ -75,6 +93,10 @@ Learn more about the [OASIS Open Document Format](http://docs.oasis-open.org/off
 
 If you want to contribute to simple-odf, you are very welcome. Send issues and pull requests with your ideas.
 
+<!--
+Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
+-->
+
 ### Pull Requests
 
 *Before* submitting a pull request, please make sure the following is done...
@@ -106,6 +128,14 @@ If you want to contribute to simple-odf, you are very welcome. Send issues and p
    npm test -- --watch
    ```
 
-### License
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/connium/simple-odf/releases).
+
+## Credits
+
+This project exists thanks to all the [contributors](https://github.com/connium/simple-odf/graphs/contributors) who participate in this project.
+
+## License
 
-By contributing to simple-odf, you agree that your contributions will be licensed under its [MIT license](./LICENSE).
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
diff --git a/package.json b/package.json
index 7cdce233..d1276363 100644
--- a/package.json
+++ b/package.json
@@ -37,7 +37,7 @@
     "watch-test": "jest --watch",
     "coverage": "jest --coverage",
     "lint": "tslint -c tslint.json --project .",
-    "docs": "rm -r ./lib && tsc && jsdoc2md --name-format --param-list-format list --separators --partial ./jsdoc2md/body.hbs ./jsdoc2md/params-list.hbs ./jsdoc2md/returns.hbs ./jsdoc2md/scope.hbs --files ./lib/api/**/*.js > ./docs/API.md"
+    "docs": "rm -r ./lib && tsc && jsdoc2md --name-format --param-list-format list --separators --partial ./tools/jsdoc2md/body.hbs ./tools/jsdoc2md/params-list.hbs ./tools/jsdoc2md/returns.hbs ./tools/jsdoc2md/scope.hbs --files ./lib/api/**/*.js > ./docs/API.md"
   },
   "dependencies": {
     "xmldom": "^0.1.27"
diff --git a/jsdoc2md/body.hbs b/tools/jsdoc2md/body.hbs
similarity index 100%
rename from jsdoc2md/body.hbs
rename to tools/jsdoc2md/body.hbs
diff --git a/jsdoc2md/params-list.hbs b/tools/jsdoc2md/params-list.hbs
similarity index 100%
rename from jsdoc2md/params-list.hbs
rename to tools/jsdoc2md/params-list.hbs
diff --git a/jsdoc2md/returns.hbs b/tools/jsdoc2md/returns.hbs
similarity index 100%
rename from jsdoc2md/returns.hbs
rename to tools/jsdoc2md/returns.hbs
diff --git a/jsdoc2md/scope.hbs b/tools/jsdoc2md/scope.hbs
similarity index 100%
rename from jsdoc2md/scope.hbs
rename to tools/jsdoc2md/scope.hbs