Skip to content

Commit 074abcc

Browse files
authored
Update README.md
1 parent 7ec7da2 commit 074abcc

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

README.md

+33-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,34 @@
1-
# Laravel-API-query-handler
1+
# [WIP] Laravel API query handler
22
This Laravel package helps to handle a query request properly
3+
4+
## Synopsis
5+
6+
At the top of the file there should be a short introduction and/ or overview that explains **what** the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)
7+
8+
## Code Example
9+
10+
Show what the library does as concisely as possible, developers should be able to figure out **how** your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.
11+
12+
## Motivation
13+
14+
A short description of the motivation behind the creation and maintenance of the project. This should explain **why** the project exists.
15+
16+
## Installation
17+
18+
Provide code examples and explanations of how to get the project.
19+
20+
## API Reference
21+
22+
Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.
23+
24+
## Tests
25+
26+
Describe and show how to run the tests with code examples.
27+
28+
## Contributors
29+
30+
Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.
31+
32+
## License
33+
34+
The Laravel API query handler is open-sourced software licensed under the MIT license.

0 commit comments

Comments
 (0)