Skip to content

Commit b678571

Browse files
committedMay 25, 2019
docs: improve usage docs & drop year on license
1 parent 411bbe1 commit b678571

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed
 

‎LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2019 lykmapipo & Contributors
3+
Copyright (c) lykmapipo & Contributors
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
66

‎README.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# predefine(WIP)
1+
# predefine
22

33
[![Build Status](https://travis-ci.org/lykmapipo/predefine.svg?branch=master)](https://travis-ci.org/lykmapipo/predefine)
44
[![Dependencies Status](https://david-dm.org/lykmapipo/predefine/status.svg?style=flat-square)](https://david-dm.org/lykmapipo/predefine)
@@ -23,10 +23,17 @@ npm install @lykmapipo/predefine --save
2323

2424
```js
2525
const { connect } = require('@lykmapipo/mongoose-common');
26-
const { app } = require('@lykmapipo/predefine');
26+
const { start, mount } = require('@lykmapipo/express-common');
27+
const { Predefine, predefineRouter } = require('@lykmapipo/predefine');
2728

28-
// start api
29-
connect(error => app.start((error, env) => { ... }));
29+
// connect to mongodb
30+
connect(process.env.MONGODB_URI, error => { ... });
31+
32+
// mount predefine http router
33+
mount(predefineRouter);
34+
35+
// fire the http server
36+
start(error => { ... });
3037
```
3138

3239
## Testing
@@ -59,7 +66,7 @@ It will be nice, if you open an issue first so that we can know what is going on
5966

6067
The MIT License (MIT)
6168

62-
Copyright (c) 2019 lykmapipo & Contributors
69+
Copyright (c) lykmapipo & Contributors
6370

6471
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6572

0 commit comments

Comments
 (0)
Please sign in to comment.