Skip to content

Commit baf10b8

Browse files
committed
Improve documentation
1 parent 2a7464e commit baf10b8

12 files changed

+340
-92
lines changed

CHANGES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Changelog #
22

3-
## v1.0.0 (2016-11-24) ##
3+
## v1.0.0 (?) ##
44

55
* Initial release

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2106 Riikka Kalliomäki
1+
Copyright (c) 2106 - 2017 Riikka Kalliomäki
22

33
Permission is hereby granted, free of charge, to any person obtaining a copy of
44
this software and associated documentation files (the "Software"), to deal in

README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Streaming Json Encoder #
2+
3+
4+
5+
## Requirements ##
6+
7+
In order to use this library, the following requirements must be met:
8+
9+
* PHP version 5.6
10+
11+
## Installation ##
12+
13+
This library can be installed by using [Composer](http://getcomposer.org/). In
14+
order to do this, you must download the latest Composer version and run the
15+
`require` command to add this library as a dependency to your project. The
16+
easiest way to complete these two tasks is to run the following two commands
17+
in your terminal:
18+
19+
```
20+
php -r "readfile('https://getcomposer.org/installer');" | php
21+
php composer.phar require "violet/streaming-json-encoder:^1.0"
22+
```
23+
24+
If you already have Composer installed on your system and you know how to use
25+
it, you can also install this library by adding it as a dependency to your
26+
`composer.json` file and running the `composer install` command. Here is an
27+
example of what your `composer.json` file could look like:
28+
29+
```json
30+
{
31+
"require": {
32+
"violet/streaming-json-encoder": "^1.0"
33+
}
34+
}
35+
```
36+
37+
After installing this library via Composer, you can load the library by
38+
including the `vendor/autoload.php` file that was generated by Composer during
39+
the installation.
40+
41+
### Manual installation ###
42+
43+
You can also install this library manually without using Composer. In order to
44+
do this, you must download the [latest release](https://github.com/violet/streaming-json-encoder/releases/latest)
45+
and extract the `src` folder from the archive to your project folder. To load
46+
the library, you can simply include the `src/autoload.php` file that was
47+
provided in the archive.
48+
49+
## Usage ##
50+
51+
52+
53+
## Credits ##
54+
55+
This library is copyright 2016 - 2017 to Riikka Kalliomäki.
56+
57+
See LICENSE for license and copying information.

0 commit comments

Comments
 (0)