Skip to content

PunchCMS client library to be included in projects that connect to PunchCMS manager

License

Notifications You must be signed in to change notification settings

neverwoods/punchcms-client

Repository files navigation

License A project by Neverwoods

About

PunchCMS Client is a client library for the PunchCMS centralised content management system. This library is used in websites that are powered by PunchCMS in order to read data from and to the

Installation

You're free to download the source and get started but we highly recommend that you use Composer to install PunchCMS Client. Add the following to your project's composer.json file:

{
    "require": {
        "neverwoods/punchcms-client": "~3"
    }
}

By using the tilde you'll automatically install bug fixes and new features. See Composer documentation for details.

Generate changelog

Make sure you've installed the node package using npm:

$ npm install

Generate the changelog:

$ chmod +x ./write-changelog.js
$ ./write-changelog.js

Documentation

We can keep this short -- there is none. Since this is a 'privately used gone public' project, we're not yet writing docs for it. In the future we will be releasing some getting started tutorials in combination with the PunchCMS manager but don't hold your breath.

Happy coding!

Felix & Robin

About

PunchCMS client library to be included in projects that connect to PunchCMS manager

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •