🔀 Merge branch 'release/2.0.0'

Pustur · May 29, 2019 · 60fbd4e · 60fbd4e
2 parents 1074829 + be0946c
commit 60fbd4e
Show file tree

Hide file tree

Showing 13 changed files with 1,507 additions and 618 deletions.
diff --git a/.babelrc b/.babelrc
@@ -0,0 +1,3 @@
+{
+  "presets": [["@babel/env", { "modules": false }]]
+}
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -7,7 +7,7 @@ jobs:
   build:
     docker:
       # specify the version you desire here
-      - image: circleci/node:8.0.0
+      - image: circleci/node:8.3.0
 
     # Specify service dependencies here if necessary
     # CircleCI maintains a library of pre-built images

diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 node_modules/
+dist/
diff --git a/.npmignore b/.npmignore
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,14 @@
-# Change Log
+# Changelog
+
+## [2.0.0] - 2019-05-29
+
+### Added
+
+- Browser support (Thanks [@Mintonne](https://github.com/Mintonne))
+
+### Removed
+
+- `parseFile` method (Node users can still read the file in their code and pass the file contents to the `parseString` function)
 
 ## [1.2.4] - 2019-04-25
 

diff --git a/README.md b/README.md
@@ -12,11 +12,16 @@ $ npm install whatsapp-chat-parser
 
 ## Usage
 
+### Node
+
 ```javascript
+const fs = require('fs');
 const whatsapp = require('whatsapp-chat-parser');
 
+const fileContents = fs.readFileSync('path/to/file.txt', 'utf8');
+
 whatsapp
-  .parseFile('path/to/file.txt')
+  .parseString(fileContents)
   .then(messages => {
     // Do whatever you want with messages
   })
@@ -25,6 +30,33 @@ whatsapp
   });
 ```
 
+### Browser
+
+Add the script to your HTML file (usually just before the closing `</body>` tag).  
+Then use it in your JavaScript code, the `whatsappChatParser` variable will be globally available.
+
+```html
+<script src="path/to/whatsapp-chat-parser.min.js"></script>
+<script>
+  whatsappChatParser
+    .parseString('06/03/2017, 00:45 - Sample User: This is a test message')
+    .then(messages => {
+      // Do whatever you want with messages
+    })
+    .catch(err => {
+      // Something went wrong
+    });
+</script>
+```
+
+You can also use the [jsDelivr CDN](https://www.jsdelivr.com/package/npm/whatsapp-chat-parser).
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/whatsapp-chat-parser/dist/whatsapp-chat-parser.min.js"></script>
+```
+
+&nbsp;
+
 The `messages` variable is an array of objects like this:
 
 ```javascript
@@ -56,18 +88,6 @@ In the case of a system message, the author will be `System`
 
 ## API
 
-### parseFile(filepath, [options]) → Promise
-
-**filepath**
-
-Type: `string`
-
-Path to the file to parse.
-
-**options**
-
-Type: `object`
-
 ### parseString(string, [options]) → Promise
 
 **string**
@@ -88,6 +108,12 @@ Type: `object`
 | daysFirst | `Boolean` | `undefined` | Specify if your log file's date starts with a day (`true`) or a month (`false`). Manually specifying this may improve performance. By default the program will try to infer this information using 3 different methods (look at [`date.js`](src/date.js) for the implementation), if all fails it defaults to interpret the first digit as the day. |
 <!-- prettier-ignore-end -->
 
+## How to export WhatsApp chats
+
+- [Android](https://faq.whatsapp.com/en/android/23756533/)
+- [iPhone](https://faq.whatsapp.com/en/iphone/20888066/#email)
+- [Windows Phone](https://faq.whatsapp.com/en/wp/22548236)
+
 ## Technologies used
 
 - Testing: [Jest](https://jestjs.io/)
@@ -96,7 +122,14 @@ Type: `object`
 
 ## Requirements
 
-`Node.js >= 8.0.0`
+### Node
+
+`Node.js >= 8.3.0`
+
+### Browser
+
+This package is written in ES6 and transpiled to ES5.  
+It should work in all relevant browsers but at the moment I have no time to test it and provide an official compatibility table. So no guarantees, sorry.
 
 ## Changelog