Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Release 1.0.0

  • Loading branch information...
commit 8283f84c0cb8357308d63724754f6457a5752d23 1 parent cd9496b
@ammmir authored
Showing with 10 additions and 7 deletions.
  1. +9 −6 README.md
  2. +1 −1  package.json
View
15 README.md
@@ -1,11 +1,5 @@
# OAuth 2 Provider for Connect & Express
-WARNING: If you're using this module via npm, be sure to use a specific
-version in your `package.json` since until this module reaches 1.x there
-will be breaking changes in both npm and master. Stable releases are
-tagged on GitHub, so use those versions to pull down a specific one from
-npm.
-
This is a node.js module for implementing OAuth2 servers (providers)
that support server-side (code) and client-side (token) OAuth flows.
@@ -14,6 +8,15 @@ OAuth token storage and client lists. In the future, a Mongo or Redis
backed abstraction will be provided so you don't need to care about
any kind of storage at all.
+## Using it with npm
+
+If you're using this module via npm, please be sure the bracket the
+version in your app's `package.json` file. Major versions may have an
+incompatible API that's not backwards-compatible, so use a safe version
+range under `dependencies` (eg. for version 1.x):
+
+ "oauth2-provider": ">=1.0.0 <2.0.0"
+
## Quick Start
Install via npm:
View
2  package.json
@@ -1,6 +1,6 @@
{
"name": "oauth2-provider",
- "version": "0.0.2",
+ "version": "1.0.0",
"description": "A simple customizable OAuth 2.0 provider (server) for node.js.",
"homepage": "https://github.com/ammmir/node-oauth2-provider",
"author": {
Please sign in to comment.
Something went wrong with that request. Please try again.