From 9bcb5ec3a9c8b9414665b5136248d608096cc830 Mon Sep 17 00:00:00 2001
From: Laurent Cozic <laurent22@users.noreply.github.com>
Date: Mon, 21 May 2018 23:20:53 +0100
Subject: [PATCH] Update README.md

---
 README.md | 16 +++++++---------
 1 file changed, 7 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index f8caa811d..c05a4f57c 100644
--- a/README.md
+++ b/README.md
@@ -2,19 +2,17 @@
 
 A [Turndown](https://github.com/domchristie/turndown) plugin which adds GitHub Flavored Markdown extensions.
 
+This is a fork of the original [turndown-plugin-gfm](https://github.com/domchristie/turndown-plugin-gfm) for use with [Joplin](https://github.com/laurent22/joplin). The changes are:
+
+- Always render tables even they don't have a header.
+- Don't render the border of tables that contain other tables (frequent for websites that do the layout using tables). Only render the inner tables, if any, and if they also don't contain other tables.
+
 ## Installation
 
 npm:
 
 ```
-npm install turndown-plugin-gfm
-```
-
-Browser:
-
-```html
-<script src="https://unpkg.com/turndown/dist/turndown.js"></script>
-<script src="https://unpkg.com/turndown-plugin-gfm/dist/turndown-plugin-gfm.js"></script>
+npm install joplin-turndown-plugin-gfm
 ```
 
 ## Usage
@@ -22,7 +20,7 @@ Browser:
 ```js
 // For Node.js
 var TurndownService = require('turndown')
-var turndownPluginGfm = require('turndown-plugin-gfm')
+var turndownPluginGfm = require('joplin-turndown-plugin-gfm')
 
 var gfm = turndownPluginGfm.gfm
 var turndownService = new TurndownService()