Skip to content

Commit

Permalink
chore(project): renaming
Browse files Browse the repository at this point in the history
see #57
  • Loading branch information
bzums committed Jul 24, 2017
1 parent 7ab34fd commit 01a7c05
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# lib-oauth-tooling
# authmosphere

[![Build Status](https://travis-ci.org/zalando-incubator/lib-oauth-tooling.svg)](https://travis-ci.org/zalando-incubator/lib-oauth-tooling)
[![Coverage Status](https://coveralls.io/repos/github/zalando-incubator/lib-oauth-tooling/badge.svg)](https://coveralls.io/github/zalando-incubator/lib-oauth-tooling)
[![npm download](https://img.shields.io/npm/dm/lib-oauth-tooling.svg?style=flat-square)](https://www.npmjs.com/package/lib-oauth-tooling)
[![npm version](https://img.shields.io/npm/v/lib-oauth-tooling.svg?style=flat)](https://www.npmjs.com/package/lib-oauth-tooling)

## Project renaming

The project was renamed from `lib-oauth-tooling` to `authmosphere`. In the course of this renaming versioning was restarted at `0.1.0`. Currently the change is non-breaking from a code perspective. Version `1.0.0` is soon to be released, keep track of the progess in https://github.com/zalando-incubator/lib-oauth-tooling/issues/92, this relesdr will most likely contain breaking changes.

## Introduction

A simple typescript based library for supporting OAuth2 flows.
Currently the following flows are supported:

Expand All @@ -17,7 +23,7 @@ Currently the following flows are supported:
See [STUPS documentation](http://stups.readthedocs.org/en/latest/user-guide/access-control.html#implementing-a-client-asking-resource-owners-for-permission) and [OAuth2 documentation](https://tools.ietf.org/html/rfc6749) for more information.


## Migrating to 2.x.x
## Migrating from lib-oauth-tooling@1.x.x to lib-oauth-tooling@2.x.x / authmosphere@0.1.0

If you depend on the `realm` property you now have to pass the value via the `queryParams` parameters in `OAuthConfig`:

Expand Down
6 changes: 2 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "lib-oauth-tooling",
"version": "2.4.1",
"name": "authmosphere",
"version": "0.1.0",
"description": "A simple typescript based oauth tooling library",
"main": "./lib/src/index.js",
"typings": "./lib/src/index.d.ts",
Expand All @@ -10,8 +10,6 @@
"oauth2",
"express",
"node",
"service",
"rest",
"typescript"
],
"publishConfig": {
Expand Down

0 comments on commit 01a7c05

Please sign in to comment.