Skip to content

Commit 8e4a3ba

Browse files
committed
Added readme
1 parent 2bcd08e commit 8e4a3ba

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

+23-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,23 @@
1-
oauthd_default_plugin_me
2-
========================
1+
oauthd slashme
2+
==============
3+
4+
This is the **Slashme** plugin for oauthd. oauthd is the open source version of [OAuth.io](https://oauth.io)'s core, which allows you to easily integrate over 100 OAuth provider and use their APIs.
5+
6+
This plugin gives you the possibility to retrieve unified user information from many of the available providers, by adding the `https://[yoururl]/auth/:privder/me` endpoint.
7+
8+
To learn more about oauthd, please check out [oauthd's repository](https://github.com/oauth-io/oauthd).
9+
10+
Installation
11+
------------
12+
13+
To install this plugin in an oauthd instance, just run the following command (you need to have oauthd installed):
14+
15+
```sh
16+
$ oauthd plugins install https://github.com/oauth-io/oauthd-slashme.git
17+
```
18+
19+
If you want to install a specific version or branch of this plugin, just run:
20+
21+
```sh
22+
$ oauthd plugins install https://github.com/oauth-io/oauthd-slashme.git#branch_or_tag
23+
```

0 commit comments

Comments
 (0)