Create clearer Readme - Githubissues

charsme commented 6 years ago

Readme harus sesuai dengan isi repo. Butuh dijabarkan dengan lebih detail. Yang butuh di include kan.

[x] Description dari sdk nya
[x] Constraint penggunaan, limitasi versi php dan extension yang dibutuhkan
[x] Cara retrieve release version dan constraint versi sdk. Installation
[x] Basic usage dari package nya
[x] Integrasi badge CI/CD dan status build tiap release sama badge latest version dari package nya
[x] Tambahin di readme cara pake package nya misal mau manual git clone
[x] Tambah section di readme untuk proses sebelum commit dan PR, running cs-fix, cek scrutinizer, fix all patches dan rebase.

charsme commented 6 years ago

Installation usage could use this syntax composer require kly/onesdk tag already updated to v1.1.5

charsme commented 6 years ago

@kennykarnama Tolong bantu readme dulu ya. Bisa bagian basic usage untuk sdk nya. Declare publisher, create Article, attachment dan semacamnya.

Lalu untuk constrain php minim versi 5.3.3

Untuk cara retrieve release coba pelajari cara require package berdasarkan version constraint. Bisa langsung di readme nya.

KLYgarage / onesdk