Skip to content

Commit

Permalink
docs(*): register package and update README
Browse files Browse the repository at this point in the history
  • Loading branch information
softmonkeyjapan committed Mar 21, 2017
1 parent 6b8e96d commit e9ce9f9
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 9 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,26 @@
SimpleResource
==============

[![CircleCI](https://circleci.com/gh/wamland-team/simple-resource.svg?style=shield&circle-token=620045f0f5415b519c4a9b1d4ca98200f18b4acc)](https://circleci.com/gh/wamland-team/simple-resource)
[![CircleCI](https://circleci.com/gh/softmonkeyjapan/simple-resource.svg?style=shield&circle-token=c26d5c8aeb9d99cdba26ae252862c49330c212fc)](https://circleci.com/gh/softmonkeyjapan/simple-resource)
[![npm version](https://badge.fury.io/js/simpleresource.svg)](http://badge.fury.io/js/simpleresource)
[![Bower version](https://badge.fury.io/bo/simpleresource.svg)](http://badge.fury.io/bo/simpleresource)

SimpleResource aims to provide a simple way to connect your Angular application to a RESTful backend API.

# Installation

You can use either `bower`

```
bower install simpleresource --save
```

or `npm` to install the package

```
npm install simpleresource --save
```

# Quick setup

1. Start by defining your API domain by injecting `SimpleResourceSettingsProvider` in a `angular.config` block:
Expand Down Expand Up @@ -143,7 +159,4 @@ Note that using a `string` for the constructor will use the global `apiUrl` defi

# Todos

- [ ] SimpleResource methods
- [ ] SimpleResource configuration
- [ ] SimplePaginator API
- [ ] SimplePaginator configuration
- [ ] Improve documentation
6 changes: 3 additions & 3 deletions bower.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "simple-resource",
"name": "simpleresource",
"version": "1.0.0",
"authors": [
"Loic Kartono <[email protected]>"
Expand All @@ -8,10 +8,10 @@
"main": "dist/simple-resource.js",
"repository": {
"type": "git",
"url": "git://github.com/wamland-team/simple-resource.git"
"url": "git://github.com/softmonkeyjapan/simple-resource.git"
},
"license": "MIT",
"homepage": "https://github.com/wamland-team/simple-resource",
"homepage": "https://github.com/softmonkeyjapan/simple-resource",
"ignore": [
"**/.*",
"node_modules",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "simple-resource",
"name": "simpleresource",
"version": "1.0.0",
"description": "Connects business objects and REST web services for Angular.js",
"author": "Loic Kartono <[email protected]> (http://www.kartono-loic.com)",
Expand Down

0 comments on commit e9ce9f9

Please sign in to comment.