Skip to content

Commit 5c88d69

Browse files
author
Henry Smith
committed
Big README update
1 parent a93153b commit 5c88d69

1 file changed

Lines changed: 34 additions & 24 deletions

File tree

README.md

Lines changed: 34 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -53,41 +53,51 @@ Console](https://github.com/h2s/reddit-console)" project for reference purposes.
5353
Development Status
5454
------------------
5555

56-
This library exposes the majority of the functionality of the API.
57-
58-
Anything to do with 'flair' isn't supported, but I can't see much demand for
59-
that functionality anyway, so I can't find the motivation to actully implement
60-
it.
61-
62-
Submitting self-posts isn't working yet, which is the only important missing
63-
feature left that I know of. I will remove this paragraph as soon as this is
64-
resolved.
65-
66-
Pull requests are welcome by the way!
56+
Reddit's API is big, and the service description JSON in the
57+
[`./api/`](https://github.com/h2s/reddit-api-client/tree/master/api) directory
58+
is incomplete.
59+
60+
#### Supported URIs
61+
62+
* `api/login/{user}`
63+
* `api/me.json`
64+
* `api/register`
65+
* `api/submit`
66+
* `api/vote`
67+
* `by_id/t3_{id}.json`
68+
* `r/{subreddit}.json`
69+
* `user/{id}.json`
70+
* `user/{id}/about.json`
71+
72+
The above list covers many of the most common interactions such as logging in,
73+
reading and posting links and comments, and casting votes. However, there are
74+
dozens more services available in Reddit's API, and simple pull requests adding
75+
entries to the service description JSON are very welcome.
6776

6877
Contributing
6978
------------
7079

7180
This is a fairly simple project so there aren't many guidelines. I've you've
72-
fixed a bug or added a feature let's get it merged back in. There are only two
73-
rules:
81+
fixed a bug or added a feature, let's get it merged back in. There are two hard
82+
rules.
7483

75-
#### 1. Run the tests
84+
#### 1. Test-drive your changes
7685

77-
$ ./vendor/bin/phpunit
86+
This project is test-driven. Please don't submit any code changes without a
87+
corresponding set of unit tests.
7888

79-
Please make sure the tests pass before submitting a pull request. Ideally, your
80-
pull request should include one or more new tests for the bug fix or new
81-
functionality you're introducing.
89+
```bash
90+
$ make phpunit
91+
```
8292

83-
#### 2. Follow the PSR-2 style guide
93+
#### 2. Follow PSR2
8494

85-
$ ./vendor/bin/phpcs --standard=PSR2 src/
95+
Stick to the [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)
96+
standard.
8697

87-
This project complies with the
88-
[PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)
89-
standard. Your pull request is probably already within these guidelines but it's
90-
good to double check.
98+
```bash
99+
$ make phpcs
100+
```
91101

92102
License
93103
-------

0 commit comments

Comments
 (0)