Skip to content
This repository was archived by the owner on Jan 20, 2020. It is now read-only.

Commit 3c84e05

Browse files
author
Luciano Nooijen
committed
Readme updates
1 parent 912ab3c commit 3c84e05

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To use the NodeJS Blog module, first, import the package
3434

3535
```js
3636
const nodeBlog = require('nodejs-blog');
37-
const { authors, auth, users, articles } = require('nodejs-blog');
37+
const { authors, auth, users, categories, articles } = require('nodejs-blog');
3838
```
3939

4040
to start using the package, create a new instance of the NodeBlog class
@@ -76,20 +76,30 @@ users.add(blog, userObject)
7676
users.modify(blog, id, modifiedData)
7777
users.delete(blog, id)
7878

79+
categories.list(blog)
80+
categories.get(blog, id)
81+
categories.add(blog, categoryObject)
82+
categories.modify(blog, id, modifiedData)
83+
categories.delete(blog, id)
84+
7985
articles.list(blog)
8086
articles.get(blog, id)
8187
articles.add(blog, articleObject)
82-
articles.modify(blog, id, modifiedData)
88+
// articles.modify(blog, id, modifiedData) // not available yet
8389
articles.delete(blog, id)
8490
```
8591

8692
We recommend creating a single file that will create the NodeBlog instance, and `export` this instance, and `import` in all other files where you want to use NodeJS Blog.
8793

8894
For security reasons we recommend using environment variables for loading the configuration. This is also in compliance with the [12 factor app Config guidelines](https://12factor.net/config)
8995

90-
Note: NodeJS blog was made to be used with PostgreSQL, but it should(/could) also be compatible with other databases, as it uses KnexJS under the hood.
96+
Note: NodeJS blog was made to be used with PostgreSQL, but it should(/could) also be compatible with other databases, as it uses [KnexJS](https://knexjs.org) under the hood.
97+
98+
*A demo application is currently in development*
99+
100+
## Running the API as a standalone service (still in development, might not work 100%)
91101

92-
## Running the API as a standalone service
102+
First clone the repository and `cd` into the directory.
93103

94104
To run NodeJS Blog as a standalone service, run `cp .env.example .env` to create the `.env` file.
95105

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy