improve README and add app veyor
This commit is contained in:
parent
a990c5ca32
commit
3b8e31c8b0
27
README.md
27
README.md
@ -1,11 +1,34 @@
|
|||||||
# smartstring
|
# smartstring
|
||||||
handle strings in smart ways.
|
handle strings in smart ways. TypeScript ready.
|
||||||
|
|
||||||
## Status
|
## Status
|
||||||
[![Build Status](https://travis-ci.org/pushrocks/smartstring.svg?branch=master)](https://travis-ci.org/pushrocks/smartstring)
|
[![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)
|
[![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 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)
|
[![bitHound Code](https://www.bithound.io/github/pushrocks/smartstring/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartstring)
|
||||||
|
|
||||||
## Usage
|
## 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"
|
||||||
|
|
||||||
|
```
|
||||||
|
10
appveyor.yml
Normal file
10
appveyor.yml
Normal file
@ -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
|
Loading…
Reference in New Issue
Block a user