Skip to content
This repository has been archived by the owner on Dec 21, 2020. It is now read-only.

Commit

Permalink
Update README and package version
Browse files Browse the repository at this point in the history
  • Loading branch information
edward-hsu-1994 committed Dec 5, 2017
1 parent b986900 commit 3afb4e0
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
# uriBuilder

[![npm version](https://badge.fury.io/js/uribuilder.svg)](https://badge.fury.io/js/uribuilder)
[![Build Status](https://travis-ci.org/XuPeiYao/uriBuilder.svg?branch=master)](https://travis-ci.org/XuPeiYao/uriBuilder) [![Downloads](https://img.shields.io/npm/dm/uribuilder.svg)](https://www.npmjs.com/package/uribuilder) [![license](https://img.shields.io/github/license/xupeiyao/uribuilder.svg)](https://github.com/XuPeiYao/uriBuilder/blob/master/LICENSE)
[![Build Status](https://travis-ci.org/XuPeiYao/uriBuilder.svg?branch=master)](https://travis-ci.org/XuPeiYao/uriBuilder)
[![Downloads](https://img.shields.io/npm/dm/uribuilder.svg)](https://www.npmjs.com/package/uribuilder)
[![license](https://img.shields.io/github/license/xupeiyao/uribuilder.svg)](https://github.com/XuPeiYao/uriBuilder/blob/master/LICENSE)

URI parser and builder

## Install

```powershell
npm install uribuilder
```

## Getting Started

```typescript
// import module
import { UriBuilder } from 'uribuilder';
Expand Down Expand Up @@ -58,4 +63,10 @@ emptyBuilder.query.chinese = '中文';

// Log builder result, result: http://guest@example/home/index?action=back&chinese=%E4%B8%AD%E6%96%87#top
console.log(emptyBuilder.toString());
```

// Relative path
const relativeBuilder = UriBuilder.parse('./home/exam?id=0');
relativeBuilder.query.id = 1;
// Log builder result, result: ./home/exam?id=1
console.assert(relativeBuilder.toString());
```
7 changes: 2 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
{
"name": "uribuilder",
"version": "1.0.2",
"version": "1.0.3",
"description": "URI builder and parser",
"main": "index.js",
"scripts": {
"build": "gulp build",
"test": "npm run build && node dist/test.js"
},
"keywords": [
"URI",
"URL"
],
"keywords": ["URI", "URL"],
"homepage": "https://github.com/XuPeiYao/uriBuilder",
"repository": {
"type": "git",
Expand Down

0 comments on commit 3afb4e0

Please sign in to comment.