1
0
mirror of https://github.com/dkhamsing/open-source-ios-apps.git synced 2025-01-25 13:38:34 +01:00

58 lines
1.3 KiB
Markdown
Raw Normal View History

2016-05-11 09:27:30 -07:00
To contribute to`open-source-ios-apps`, please update the **contents.json** file (this will generate the README).
2016-05-11 07:22:01 -07:00
2016-05-11 08:25:14 -07:00
## New category
Please [open an issue](https://github.com/dkhamsing/open-source-ios-apps/issues) and contact
2016-05-11 09:27:30 -07:00
@dkhamsing, @kvnbautista or @scribblemaniac.
2016-05-11 08:25:14 -07:00
## New app
2016-05-11 07:22:01 -07:00
Adding a `JSON` entry
### New entries go to the end of the file
2016-05-11 09:23:21 -07:00
Example: https://github.com/dkhamsing/open-source-ios-apps/pull/281/files
2016-05-11 08:25:14 -07:00
At the end of **contents.json**, add an entry at `}]`
2016-05-11 07:22:01 -07:00
```js
"stars": 100
}] // here
}
```
2016-05-11 08:25:14 -07:00
Insert a comma between `}` and `]` and create a new entry with the format below.
2016-05-11 07:22:01 -07:00
2016-05-11 08:25:14 -07:00
### Format
2016-05-11 07:22:01 -07:00
At minimum
```js
{
2016-05-11 08:25:14 -07:00
"title": "MrCode",
2016-05-11 07:22:01 -07:00
"category": "github",
"description": "GitHub iPhone app that can cache Markdown content",
"source": "https://github.com/haolloyin/MrCode" // note, no comma on last line
}
```
Optionally
```js
{
2016-05-11 08:25:14 -07:00
"title": "App name",
"category": ["github", "parse"],
"description": "Describe what this app does",
2016-05-11 09:27:30 -07:00
"lang": "zho", // ISO 639-2 code
2016-05-11 08:25:14 -07:00
"source": "https://github.com/user/repo",
"homepage": "https://awesome-url",
2016-05-11 07:22:01 -07:00
"itunes": "https://itunes.apple.com/app/id1234567890",
"tags": ["swift"],
2016-05-11 08:25:14 -07:00
"stars": 200 // number of GitHub stars
2016-05-11 07:22:01 -07:00
}
```
2016-05-11 09:27:30 -07:00
For `lang` (language), use ISO 639-2 https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes
2016-05-11 07:22:01 -07:00
Thanks for contributing :tada: