Skip to content

Commit 2b52389

Browse files
committed
docs(*): add some TODOs and cleanup the docs
1 parent c61d3e5 commit 2b52389

File tree

2 files changed

+18
-26
lines changed

2 files changed

+18
-26
lines changed

Diff for: .gitignore

+5-24
Original file line numberDiff line numberDiff line change
@@ -11,33 +11,14 @@ pids
1111
*.seed
1212
*.pid.lock
1313

14-
# Directory for instrumented libs generated by jscoverage/JSCover
15-
lib-cov
16-
17-
# Coverage directory used by tools like istanbul
14+
# Coverage directory
1815
coverage
1916

20-
# nyc test coverage
21-
.nyc_output
22-
23-
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
24-
.grunt
25-
26-
# Bower dependency directory (https://bower.io/)
27-
bower_components
28-
29-
# node-waf configuration
30-
.lock-wscript
31-
3217
# Compiled binary addons (https://nodejs.org/api/addons.html)
3318
build/Release
3419

3520
# Dependency directories
3621
node_modules/
37-
jspm_packages/
38-
39-
# TypeScript v1 declaration files
40-
typings/
4122

4223
# Optional npm cache directory
4324
.npm
@@ -54,8 +35,8 @@ typings/
5435
# Yarn Integrity file
5536
.yarn-integrity
5637

57-
# dotenv environment variables file
58-
.env
38+
# Misc
39+
/_
5940

60-
# next.js build output
61-
.next
41+
# JetBrains IDEs
42+
.idea

Diff for: README.md

+13-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
1-
# netlify-cms-oauth-provider-node
2-
An stateless external OAuth provider for netlify-cms with built-in support for Zeit Now serverless functions
1+
# `netlify-cms-oauth-provider-node`
2+
3+
A stateless [external OAuth provider](https://www.netlifycms.org/docs/authentication-backends/#external-oauth-clients)
4+
for `netlify-cms`.
5+
6+
This package exposes an API that makes it easy to use in a traditional long-running Node server (i.e. using `express`)
7+
or in stateless serverless functions (i.e.
8+
[Zeit Now Serverless Functions](https://zeit.co/docs/v2/serverless-functions/introduction)).
9+
10+
## TODO
11+
12+
- [ ] Basic modularized/abstract implementation
13+
- [ ] Usage instructions

0 commit comments

Comments
 (0)