mirror of
https://github.com/dkhamsing/open-source-ios-apps.git
synced 2025-01-10 15:33:24 +01:00
58 lines
1.3 KiB
Markdown
58 lines
1.3 KiB
Markdown
To contribute to`open-source-ios-apps`, please update the **contents.json** file (this will generate the README).
|
|
|
|
## New category
|
|
|
|
Please [open an issue](https://github.com/dkhamsing/open-source-ios-apps/issues) and contact
|
|
@dkhamsing, @kvnbautista or @scribblemaniac.
|
|
|
|
## New app
|
|
|
|
Adding a `JSON` entry
|
|
|
|
### New entries go to the end of the file
|
|
|
|
Example: https://github.com/dkhamsing/open-source-ios-apps/pull/281/files
|
|
|
|
At the end of **contents.json**, add an entry at `}]`
|
|
|
|
```js
|
|
"stars": 100
|
|
}] // here
|
|
}
|
|
```
|
|
|
|
Insert a comma between `}` and `]` and create a new entry with the format below.
|
|
|
|
### Format
|
|
|
|
At minimum
|
|
|
|
```js
|
|
{
|
|
"title": "MrCode",
|
|
"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
|
|
{
|
|
"title": "App name",
|
|
"category": ["github", "parse"],
|
|
"description": "Describe what this app does",
|
|
"lang": "zho", // ISO 639-2 code
|
|
"source": "https://github.com/user/repo",
|
|
"homepage": "https://awesome-url",
|
|
"itunes": "https://itunes.apple.com/app/id1234567890",
|
|
"tags": ["swift"],
|
|
"stars": 200 // number of GitHub stars
|
|
}
|
|
```
|
|
|
|
For `lang` (language), use ISO 639-2 https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes
|
|
|
|
Thanks for contributing :tada:
|