grav-plugin-api icon indicating copy to clipboard operation
grav-plugin-api copied to clipboard

Published 20 hours ago • verified publisher icon Regaez

docs: update project readme

Open Regaez opened this issue 4 years ago • 1 comments

The readme file is currently the default template for a Grav plugin. It needs to be updated with more relevant information.

  • Configuration and setup of plugin
  • Granting user permissions for API usage
  • Roadmap/ desired features
  • More details regarding development environment
  • Warning about using API on your site. Potential security vulnerability etc.
  • Supported version of Grav
  • ... etc.

Regaez avatar Mar 19 '20 20:03 Regaez

  • Remove the "installation by gpm" section until the plugin is actually released to gpm.
  • add a section "when to use?" comparing the api plugin vs grav's existing content type functionality. You might not need the api.

Regaez avatar May 16 '20 05:05 Regaez