Skip to content

Commit

Permalink
chore: Restore package old name, add download badge to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
teclone committed Jul 15, 2018
1 parent 441349a commit ea2d59d
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# R-Serializer
# XML-Serializer

[![Build Status](https://travis-ci.org/harrison-ifeanyichukwu/r-serializer.svg?branch=master)](https://travis-ci.org/harrison-ifeanyichukwu/r-serializer)
[![Coverage Status](https://coveralls.io/repos/github/harrison-ifeanyichukwu/r-serializer/badge.svg?branch=master)](https://coveralls.io/github/harrison-ifeanyichukwu/r-serializer?branch=master)
[![Build Status](https://travis-ci.org/harrison-ifeanyichukwu/xml-serializer.svg?branch=master)](https://travis-ci.org/harrison-ifeanyichukwu/xml-serializer)
[![Coverage Status](https://coveralls.io/repos/github/harrison-ifeanyichukwu/xml-serializer/badge.svg?branch=master)](https://coveralls.io/github/harrison-ifeanyichukwu/xml-serializer?branch=master)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![npm version](https://badge.fury.io/js/%40harrison-ifeanyichukwu%2Fr-serializer.svg)](https://badge.fury.io/js/%40harrison-ifeanyichukwu%2Fr-serializer)
[![npm version](https://badge.fury.io/js/%40harrison-ifeanyichukwu%2Fxml-serializer.svg)](https://badge.fury.io/js/%40harrison-ifeanyichukwu%2Fxml-serializer)
![npm](https://img.shields.io/npm/dw/%40harrison-ifeanyichukwu%2Fxml-serializer.svg)

R-Serializer is a complete JavaScript implementation of the W3C [xml serialization](https://www.w3.org/TR/DOM-Parsing/#dfn-concept-serialize-xml) specifications. All specifications have been implemented and includes the following [specs](https://www.w3.org/TR/DOM-Parsing/#dfn-concept-xml-serialization-algorithm):
XML-Serializer is a complete JavaScript implementation of the W3C [xml serialization](https://www.w3.org/TR/DOM-Parsing/#dfn-concept-serialize-xml) specifications. All specifications have been implemented and includes the following [specs](https://www.w3.org/TR/DOM-Parsing/#dfn-concept-xml-serialization-algorithm):

- [ELEMENT_NODE Serialization]

Expand All @@ -23,16 +24,16 @@ R-Serializer is a complete JavaScript implementation of the W3C [xml serializati

## Module Availability

This module is available as an [npm](https://www.npmjs.com/) package and also has a browser build that is located inside the `dist` folder. It can easily be integrated with [JSDOM](https://github.com/jsdom/jsdom) for mockup testing.
This module is available as an [npm](https://www.npmjs.com/) scoped package and also has a browser build that is located inside the `dist` folder. It can easily be integrated with [JSDOM](https://github.com/jsdom/jsdom) for mockup testing.

## Getting Started

The below command will install `r-serializer` from npm into your project assuming you have the [npm](https://www.npmjs.com/) already installed.
The below command will install `xml-serializer` from npm into your project assuming you have the [npm](https://www.npmjs.com/) already installed.

**Install as a development dependency**:

```bash
npm install --save-dev r-serializer
npm install --save-dev @harrison-ifeanyichukwu/xml-serializer
```

## Usage Guide
Expand Down
11 changes: 5 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "r-serializer",
"name": "@harrison-ifeanyichukwu/xml-serializer",
"version": "0.0.0-development",
"description": "R-Serializer is a complete JavaScript implementation of the W3C xml serialization specifications",
"description": "xml-serializer is a complete JavaScript implementation of the W3C xml serialization specifications",
"main": "lib/main.js",
"publishConfig": {
"access": "public"
Expand All @@ -13,14 +13,13 @@
"report-coverage": "nyc report --reporter=text-lcov | coveralls",
"prebuild": "rimraf dist && rimraf lib",
"build": "BABEL_ENV=build rollup --config",
"travis-deploy-once": "travis-deploy-once",
"semantic-release": "semantic-release",
"validate-doc": "documentation lint src/**/*.js",
"generate-doc": "rimraf docs/docs && documentation build src/**/*.js -f html -o docs/docs"
},
"repository": {
"type": "git",
"url": "https://github.com/harrison-ifeanyichukwu/r-serializer.git"
"url": "https://github.com/harrison-ifeanyichukwu/xml-serializer.git"
},
"keywords": [
"xml-serialization",
Expand All @@ -32,9 +31,9 @@
"author": "Harrison Ifeanyichukwu <[email protected]> (https://harrison-ifeanyichukwu.github.io/)",
"license": "MIT",
"bugs": {
"url": "https://github.com/harrison-ifeanyichukwu/r-serializer/issues"
"url": "https://github.com/harrison-ifeanyichukwu/xml-serializer/issues"
},
"homepage": "https://github.com/harrison-ifeanyichukwu/r-serializer#readme",
"homepage": "https://github.com/harrison-ifeanyichukwu/xml-serializer#readme",
"devDependencies": {
"babel-plugin-external-helpers": "6.22.0",
"babel-preset-env": "1.7.0",
Expand Down

0 comments on commit ea2d59d

Please sign in to comment.