Merge pull request #1 from ambassify/chore/npm-fork

[ambassify] add info about npm fork

README.md

@@ -1,4 +1,8 @@
-# twitter-text
+# @ambassify/twitter-text
+
+This is Ambassify's fork of the twitter-text library. Only the npm package is published at this time. Check its README to see which adjustments we made.
+
+## Original README
 
 This repository is a collection of libraries and conformance tests to standardize parsing of Tweet text. It synchronizes development, testing, creating issues, and pull requests for twitter-text's implementations and specification. These libraries are responsible for determining the quantity of characters in a Tweet and identifying and linking any URL, @username, #hashtag, or $cashtag.
 
@@ -12,7 +16,7 @@ See implementations and conformance in this repository below:
 
 ## Other language implementations
 
-The following implementations exist in other programming languages, but are not supported by or used by Twitter. 
+The following implementations exist in other programming languages, but are not supported by or used by Twitter.
 We'd like to thank the authors for building and maintaining these alternatives.
 
 * [Swift](https://swiftpack.co/package/nysander/twitter-text)

js/README.md

@@ -1,9 +1,19 @@
-[![npm](https://img.shields.io/npm/v/twitter-text.svg)](https://www.npmjs.com/package/twitter-text)
+[![npm](https://img.shields.io/npm/v/@ambassify/twitter-text.svg)](https://www.npmjs.com/package/@ambassify/twitter-text)
 
-## twitter-text-js
+# @ambassify/twitter-text-js
 
 A JavaScript utility that provides text processing routines for Tweets.  This library conforms to a common test suite shared by many other implementations, particularly twitter-text.gem (Ruby).  The library provides autolinking and extraction for URLs, usernames, lists, and hashtags.
 
+## Ambassify fork
+
+This fork of the original twitter-text library includes:
+
+- ...
+
+It's available on NPM as `npm install @ambassify/twitter-text`
+
+# Orginal README
+
 ## NPM Users
 
 Install it with: `npm install twitter-text`

js/package.json

@@ -1,17 +1,17 @@
 {
-  "name": "twitter-text",
-  "description": "official twitter text linkification",
+  "name": "@ambassify/twitter-text",
+  "description": "Ambassify's for of the official twitter text linkification library",
   "version": "3.1.0",
   "main": "dist/index.js",
   "module": "dist/esm",
   "files": [
     "dist"
   ],
-  "homepage": "https://github.com/twitter/twitter-text",
+  "homepage": "https://github.com/ambassify/twitter-text",
   "author": "Twitter Inc.",
   "repository": {
     "type": "git",
-    "url": "https://github.com/twitter/twitter-text.git"
+    "url": "https://github.com/ambassify/twitter-text.git"
   },
   "devDependencies": {
     "@babel/cli": "^7.4.0",