From 1577c8559fed2419c2809a313359cf5ebba4c6db Mon Sep 17 00:00:00 2001
From: Charlotte Vermandel <charlottevermandel@gmail.com>
Date: Wed, 28 Jul 2021 00:00:35 +0200
Subject: [PATCH] Rename package and add logo

---
 README.MD    | 33 ++++++++++++++++++++++-----------
 package.json |  4 ++--
 2 files changed, 24 insertions(+), 13 deletions(-)

diff --git a/README.MD b/README.MD
index a50b4c8..57d249c 100644
--- a/README.MD
+++ b/README.MD
@@ -1,18 +1,29 @@
-# json-stream-concat
 
-json-stream-concat is a CLI tool that combines all json files found in a directory into one big json file using streaming to avoid out-of-memory.
+
+<center>
+
+# json-boat
+
+<img src="assets/boat.png" width=300 />
+
+</center>
+
+json-boat is a tool that combines all json files found in a directory into one big json file using streaming to avoid out-of-memory.
+
+Both `read` and `write` actions are done using `streaming`. The maximum data stored in memory is the buffer size.
+
+
+## Input/Output
 
 The output JSON file contains an array with all the inputed JSON files.
-So if your JSON file contained `{ "id": 1 }` it will be stored in the output file like this:
+So if your JSON file contained `{ "id": 1 }` it will be stored in the output file like this `[{"id": 1}]`
 
-Input files:
+Some examples:
 
-file 1:
+Input files:
 ```json
 { "id": 1 }
 ```
-
-file 2:
 ```json
 { "id": 2 }
 ```
@@ -55,23 +66,23 @@ Output file:
 CLI:
 
 ```bash
-npx combine-json [options]
+npx json-boat [options]
 ```
 
 Library:
 
 ```bash
 # yarn
-yarn add combine-json
+yarn add json-boat
 
 # npm
-npm install combine-json
+npm install json-boat
 ```
 
 
 ## Usage
 
-Combine-json has two options:
+json-boat takes two parameters:
 
 - Input dir: the path to the directory containing all the jsons.
 - Output file _optional_: path to the output file.
diff --git a/package.json b/package.json
index e0cab55..751751d 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
-  "name": "combine-json",
-  "description": "Combine with streams multiple json files into one json file.",
+  "name": "json-boat",
+  "description": "Combine with streams multiple json files into one json array. Read and Write is streamed.",
   "version": "0.1.0",
   "main": "src/index.js",
   "scripts": {