dkhamsing/open-source-ios-apps
1
0
Fork 0
mirror of https://github.com/dkhamsing/open-source-ios-apps.git synced 2024-10-26 22:30:41 +03:00
Code Issues Projects Releases Wiki Activity

Updated Home (markdown)

dkhamsing 2016-08-25 08:06:39 -07:00
parent 402f782f11
commit 4999337f2c
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Home.md

@ -11,7 +11,7 @@ A new entry should update **contents.json** with this format:
```js
{
"title": "Name of the app",
"category": "Category id",
"category-ids": "Category id",
"description": "What this app does",
"source": "Link to source, usually GitHub",
"screenshots": ["http://something.com/image.png"],
@ -33,12 +33,12 @@ To delete an app, add the value **archive** to the `tags` field (more [info](htt
## New app (adding a `JSON` entry)
`title`, `category`, `description`, `source`, `date_added`, `suggested_by` and `screenshots` are required, the rest is optional.
`title`, `category-ids`, `description`, `source`, `date_added`, `suggested_by` and `screenshots` are required, the rest is optional.
```js
{
"title": "App name",
"category": ["github", "parse"],
"category-ids": ["github", "parse"],
"description": "Describe what this app does",
"source": "https://github.com/user/repo",
"homepage": "https://awesome-url",
@ -53,9 +53,7 @@ To delete an app, add the value **archive** to the `tags` field (more [info](htt
}
```
- `category`:
- Use an approved category from this list https://github.com/dkhamsing/open-source-ios-apps/wiki/Categories
- An app can belong to more than one category, in that case use a list format in the example above
- `category-ids`: List of approved `category id` (see this list https://github.com/dkhamsing/open-source-ios-apps/wiki/Categories)
- `itunes`: Link to App Store