example.json

{
  "project": {
    "name": "Example Project",
    "state": "unstable",
    "image": "/blob/master/logo.svg",
    "website": "example.com",
    "oneLiner": "Creating awesome things, while enjoying live.",
    "description": "Free software developers guarantee everyone equal rights to their programs;\nany user can study the source code, modify it, and share the program.\nBy contrast, most software carries fine print that denies users these basic rights, leaving them susceptible to the whims of its owners.\n",
    "version": "v0.0.0",
    "mainLicense": "apache2",
    "docsLicense": "CCBySa"
  },
  "vision": {
    "type": "personal",
    "overview": "This project thrives to be open, transparent and helpful.\n",
    "items": [
      "Only specific categories allowed",
      "Bugfixes only",
      "For personal projects only"
    ],
    "concept": "Example Project's core concept to showcase how, why it does what it does.",
    "aim": "Example Project should only provide a small core and further additions should be done in helper projects/plugins or some sort."
  },
  "supportPlatforms": [
    {
      "service": "Chat",
      "link": "chat.example.com"
    },
    {
      "service": "User Mailinglist",
      "link": "list.example.com"
    },
    {
      "service": "Forum",
      "link": "forum.example.com"
    }
  ],
  "supportLinks": {
    "documentation": "/docs",
    "examples": "/examples",
    "troubleshooting": "/docs/troubleshooting.md"
  },
  "readme": {
    "usageExample": "Some example ```go run cli```\n"
  },
  "contributionLinks": {
    "issueTemplate": "/.github/ISSUE_TEMPLATE.md",
    "starterIssues": "https://github.com/dear-github/dear-github/labels/starter%20issue"
  },
  "emails": {
    "commercialSupport": "payed-support@example.com",
    "security": "security@example.com",
    "coc": "coc@example.com"
  },
  "copyright": {
    "owner": "The Example Project authors",
    "year": "2017"
  },
  "cla": {
    "copyrightHolder": "Tiny Gopher"
  },
  "maintainers": [
    {
      "name": "Huge Gopher",
      "nick": "hugeGopher"
    },
    {
      "name": "Tiny Gopher",
      "nick": "tinyGopher"
    }
  ],
  "repo": {
    "link": "https://github.com/dear-github/dear-github/",
    "type": "Github"
  },
  "badges": [
    {
      "image": "https://img.shields.io/badge/state-unstable-blue.svg",
      "alt": "state"
    },
    {
      "image": "https://img.shields.io/github/release/dear-github/dear-github.svg",
      "link": "https://github.com/dear-github/dear-github/releases",
      "alt": "release"
    },
    {
      "image": "https://img.shields.io/github/license/dear-github/dear-github.svg",
      "link": "LICENSE",
      "alt": "license"
    }
  ]
}