Nothing Special   »   [go: up one dir, main page]

Skip to content

Bloggify/Bloggify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

$ bloggify

Version Downloads

We make publishing easy.

โ˜๏ธ Installation

You can install the package globally and use it as command line tool:

# Using npm
npm install --global bloggify-cli

# Using yarn
yarn global add bloggify-cli

Then, run bloggify --help and see what the CLI tool can do.

$ bloggify --help
Usage: bloggify <command> [options]

We make publishing easy.

Commands:
  start  Starts the Bloggify process.

Options:
  -h, --help     Displays this help.
  -v, --version  Displays version information.

Examples:
  $ bloggify start
  $ bloggify start -c path/to/config/file.json

Documentation can be found at https://github.com/Bloggify/Bloggify.

๐Ÿ“‹ Example

Here is an example how to use this package as library. To install it locally, as library, you can use npm install bloggify-cli (or yarn add bloggify-cli):

// This is how to include Bloggify as library.
const Bloggify = require("bloggify-cli")

// Start the Bloggify app
const app = new Bloggify("path/to/the/application/root")

// Do something after it's started
app.onLoad(err => {
    console.log(`Bloggify server running on port ${app._serverPort}`)
})

โ“ Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
  2. For bug reports and feature requests, open issues. ๐Ÿ›

๐Ÿ“ Documentation

For full API reference, see the DOCUMENTATION.md file.

๐Ÿ˜‹ How to contribute

Have an idea? Found a bug? See how to contribute.

๐Ÿ’ซ Where is this library used?

If you are using this library in one of your projects, add it in this list. โœจ

  • bloggify-starter

๐Ÿ“œ License

MIT ยฉ Bloggify