Skip to content

Commit dd05803

Browse files
Create README.md
1 parent 77cd014 commit dd05803

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Typesense PHP Client
2+
3+
PHP client for the Typesense API: https://github.com/typesense/typesense
4+
5+
Follows the Typesense [API specification](https://github.com/typesense/typesense-api-spec).
6+
7+
## Installation
8+
9+
```
10+
$ composer install devloopsnet/typesense-php
11+
```
12+
13+
You can also add `devloopsnet/typesense-php` to your project's `composer.json`.
14+
15+
## Usage
16+
17+
You can find some examples [here](https://github.com/devloopsnet/typesense-php/blob/master/examples/collection_operations.php).
18+
19+
See detailed [API documentation](https://typesense.org/api).
20+
21+
## Contributing
22+
23+
Bug reports and pull requests are welcome on GitHub at [https://github.com/devloopsnet/typesense-php].
24+
25+
## Author
26+
27+
[Abdullah Al-Faqeir](https://github.org/abdullahfaqeir)
28+
29+
## License
30+
31+
`typesense-php` is distributed under the Apache 2 license.
32+
33+

0 commit comments

Comments
 (0)