updatedeps: docs

Author: Sven Ulrich

CONTRIBUTING.md

@@ -1,10 +1,9 @@
-# Readme for developers
+# Contributing
 
 ## Getting Started
 
 1. clone this repo
-1. execute `npm install -g gulp`
-1. execute `npm install`
+1. execute `yarn install (not npm!)`
 1. code!
-1. build using `npm run build`
-1. test using `npm run test`
+1. build using `yarn build`
+1. test using `yarn test`

README.md

@@ -8,14 +8,16 @@
 # Simple lightweight string operation library for Typescript.
 ## No jQuery required! Unit tested, works with Angular.
 
+I recently got feedback that sometimes there are issues when using `String`, since its actually replacing the native `String` object from JavaScript. You can use `$String` instead. 
+
 ```typescript
- import { String, StringBuilder } from 'typescript-string-operations';
+ import { $String, StringBuilder } from 'typescript-string-operations';
  ```
-
-I recently got feedback that sometimes there are issues when using `String`, since its actually replacing the native `String` object from JavaScript. Youcan use `$String` instead. 
+ 
+The class `String` is still available, but will be removed in the future.
 
 ```typescript
- import { $String } from 'typescript-string-operations';
+ import { String } from 'typescript-string-operations';
 ```
 
 #### USAGE:

index.ts

@@ -4,6 +4,19 @@ export class $String {
     private static readonly regexNumber = /{(\d+(:\w*)?)}/g;
     private static readonly regexObject = /{(\w+(:\w*)?)}/g;
     public static empty = '';
+    public static Empty = '';
+
+    public static IsNullOrWhiteSpace(value: string | null | undefined): boolean {
+        return $String.isNullOrWhiteSpace(value);
+    }
+
+    public static Join(delimiter: string, ...args: (string | object | Array<any>)[]): string {
+        return $String.join(delimiter, ...args);
+    }
+
+    public static Format(format: string, ...args: any[]): string {
+        return $String.format(format, ...args);
+    }
 
     public static isNullOrWhiteSpace(value: string | null | undefined): boolean {
         try {
@@ -258,21 +271,7 @@ export class $String {
 }
 
 
-export class String extends $String {
-    public static Empty = '';
-
-    public static IsNullOrWhiteSpace(value: string | null | undefined): boolean {
-        return $String.isNullOrWhiteSpace(value);
-    }
-
-    public static Join(delimiter: string, ...args: (string | object | Array<any>)[]): string {
-        return $String.join(delimiter, ...args);
-    }
-
-    public static Format(format: string, ...args: any[]): string {
-        return $String.format(format, ...args);
-    }
-}
+export class String extends $String { }
 
 export class StringBuilder {
     public Values: string[];

string.d.ts

@@ -6,6 +6,9 @@ export declare class $String {
     static format(format: string, ...args: any[]): string;
 }
 
+/**
+ * @deprecated String is overriding the native `String` object, this class will be removed in the future! Use `$String` instead.
+*/
 export declare class String extends $String {
     /**
      * @deprecated The property should not be used, and will be removed in future versions! Use `String.empty` instead.