de-compromise 0.0.1 → 0.0.4

package/README.md

@@ -1,21 +1,96 @@
 <div align="center">
-  <img src="https://cloud.githubusercontent.com/assets/399657/21955696/46e882d4-da3e-11e6-94a6-720c34e27df7.jpg" />
-  <div>Computerlinguistik Im Browser!</div>
-  <a href="https://npmjs.org/package/de-compromise">
+  <img height="15px" src="https://user-images.githubusercontent.com/399657/68221862-17ceb980-ffb8-11e9-87d4-7b30b6488f16.png"/>
+  <div><b>de-compromise</b></div>
+  <img src="https://user-images.githubusercontent.com/399657/68222691-6597f180-ffb9-11e9-8a32-a7f38aa8bded.png"/>
+  <div>bescheidene Computerlinguistik im Browser</div>
+  <div><code>npm install de-compromise</code></div>
+  <div align="center">
+    <sub>
+      work-in-progress! •  in Arbeit!
+    </sub>
+  </div>
+  <img height="25px" src="https://user-images.githubusercontent.com/399657/68221862-17ceb980-ffb8-11e9-87d4-7b30b6488f16.png"/>
+  <div align="center">
+    <sub>see: 
+     <a href="https://github.com/nlp-compromise/fr-compromise">french</a> • <a href="https://github.com/nlp-compromise/es-compromise">spanish</a>  • <a href="https://github.com/spencermountain/compromise">english</a>
+    </sub>
+  </div>
+</div>
+
+<div align="center">
+  <div>
+    <a href="https://npmjs.org/package/de-compromise">
     <img src="https://img.shields.io/npm/v/de-compromise.svg?style=flat-square" />
   </a>
-  <a href="https://nodejs.org/api/documentation.html#documentation_stability_index">
-    <img src="https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square" />
+  <!-- <a href="https://codecov.io/gh/spencermountain/de-compromise">
+    <img src="https://codecov.io/gh/spencermountain/de-compromise/branch/master/graph/badge.svg" />
+  </a> -->
+  <a href="https://bundlephobia.com/result?p=de-compromise">
+    <img src="https://badge-size.herokuapp.com/spencermountain/de-compromise/master/builds/de-compromise.min.js" />
   </a>
+  </div>
 </div>
 
-`de-compromise` (kompromiss) is a **work-in-progress** port of [compromise](https://github.com/nlp-compromise/compromise) in german.
+<!-- spacer -->
+<img height="85px" src="https://user-images.githubusercontent.com/399657/68221862-17ceb980-ffb8-11e9-87d4-7b30b6488f16.png"/>
+
+
+`de-compromise` (kompromiss) is a port of [compromise](https://github.com/nlp-compromise/compromise) in german.
 
 The goal of this project is to provide a small, basic, rule-based POS-tagger.
+
+Das Ziel dieses Projekts ist es, einen kleinen, einfachen, regelbasierten POS-Tagger bereitzustellen.
+
+
+<!-- spacer -->
+<img height="15px" src="https://user-images.githubusercontent.com/399657/68221862-17ceb980-ffb8-11e9-87d4-7b30b6488f16.png"/>
+
+```js
+import ldv from 'de-compromise'
+
+let dok = ldv('Werden wir Helden für einen Tag.')
+dok.match('#Noun').out('array')
+// [ 'wir', 'Helden', 'Tag.' ]
+```
+
+### Parsing von Zahlen / Number parsing
+es kann Zahlen in natürlicher Sprache analysieren und formatieren
+```js
+let doc = ldv('Ich habe einhunderteinundzwanzig Euro')
+doc.numbers().minus(10)
+doc.text()
+// 'Ich habe einhundertelf Euro'
+```
+
+<!-- spacer -->
+<img height="15px" src="https://user-images.githubusercontent.com/399657/68221862-17ceb980-ffb8-11e9-87d4-7b30b6488f16.png"/>
+
+oder im Browser:
+```html
+<script src="https://unpkg.com/de-compromise"></script>
+<script>
+  let txt = 'Hast du etwas Zeit für mich? Dann singe ich ein Lied für dich'
+  let doc = deCompromise(txt) //globalen Namensraum
+  console.log(doc.sentences(1).json())
+  // { text:'Dann singe...', terms:[ ... ] }
+</script>
+```
+
+see [en-compromise/api](https://github.com/spencermountain/compromise#api) for full API documentation.
+
+Bitte beitreten, um zu helfen! - please join to help!
+
+<!-- spacer -->
+<img height="85px" src="https://user-images.githubusercontent.com/399657/68221862-17ceb980-ffb8-11e9-87d4-7b30b6488f16.png"/>
+
 <h2 align="center">
-  <a href="https://rawgit.com/nlp-compromise/de-compromise/master/demo/basic/index.html">Demo</a>
+  <a href="https://rawgit.com/nlp-compromise/de-compromise/master/demo/index.html">Demo</a>
 </h2>
 
+
+
+
+### Beitragen / Contributing
 ```
 git clone https://github.com/nlp-compromise/de-compromise.git
 cd de-compromise
@@ -24,14 +99,9 @@ npm test
 npm watch
 ```
 
-```js
-import ldv from 'de-compromise'
-var dok= ldv('Werden wir Helden für einen Tag.')
-dok.match('#Noun').out('array')
-// [ 'wir', 'Helden', 'Tag.' ]
-```
 
-please join to help! - Bitte beitreten, um zu helfen!
+<!-- spacer -->
+<img height="15px" src="https://user-images.githubusercontent.com/399657/68221862-17ceb980-ffb8-11e9-87d4-7b30b6488f16.png"/>
 
 <table>
   <tr align="center">
@@ -49,3 +119,8 @@ please join to help! - Bitte beitreten, um zu helfen!
     </td>
   </tr>
 </table>
+
+### See also
+* [dweiss/compound-splitter](https://github.com/dweiss/compound-splitter) - german compound-word splitter
+* [danielnaber/jwordsplitter](https://github.com/danielnaber/jwordsplitter) - Java compound-word splitter
+MIT