diff --git a/README.md b/README.md index d464c5b..04852b7 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,34 @@ # smartstring -handle strings in smart ways. +handle strings in smart ways. TypeScript ready. ## Status [![Build Status](https://travis-ci.org/pushrocks/smartstring.svg?branch=master)](https://travis-ci.org/pushrocks/smartstring) +[![Build status](https://ci.appveyor.com/api/projects/status/x4oe2xxwwcbxmk1h/branch/master?svg=true)](https://ci.appveyor.com/project/philkunz/smartstring/branch/master) [![Dependency Status](https://david-dm.org/pushrocks/smartstring.svg)](https://david-dm.org/pushrocks/smartstring) [![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartstring/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartstring/master/dependencies/npm) [![bitHound Code](https://www.bithound.io/github/pushrocks/smartstring/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartstring) ## Usage -### Git +Use TypeScript for intellisense. + +```typescript +import * as smartstring from "smartstring"; + +// smartstring.GitRepo class +let myGitRepo = new smartstring.GitRepo("git@github.com:someorg/somerepo.git"); // takes https and git and npm repo URL versions +myGitRepo.host // "github.com" +myGitRepo.user // "someorg" +myGitRepo.repo // "somerepo" +myGitRepo.accessToken // accessToken if specified with https +myGitRepo.sshUrl // ssh URL (computed also from https) +myGitRepo.httpsUrl // https URL (computed also from ssh) + +// smartstring.Domain class +let myDomain = new smartstring.Domain("https://sub.main.tld"); +myDomain.level1 // "tld" +myDomain.level2 // "main" +// level3 , level 4 and so on... +myDomain.zoneName // "main.tld" +myDOmain.protocol // "https" + +``` diff --git a/appveyor.yml b/appveyor.yml new file mode 100644 index 0000000..1e790ba --- /dev/null +++ b/appveyor.yml @@ -0,0 +1,10 @@ +environment: + nodejs_version: "4" +install: + - ps: Install-Product node $env:nodejs_version + - npm install +test_script: + - node --version + - npm --version + - npm test +build: off \ No newline at end of file