Skip to content

Commit b558de0

Browse files
authored
Create README.md with API and contribution details
Added initial documentation for the BuniMart API, including contribution guidelines.
1 parent e78c707 commit b558de0

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# BuniMart API
2+
This is the BuniMart API that should be used to route requests for products, categories, and images (TBA), published on a seperate repository to not publish the whole source code.
3+
4+
## Contributions
5+
### If you do not know how to use GitHub or write products in JSON:
6+
[Create a new issue](https://github.com/ilikecereal1/BuniMart-API/issues/new/choose) and fill in the appropriate template.
7+
### If you know what you're doing:
8+
Fork this repository, add your changes and make a pull request.
9+
#### Note for people who want to directly contribute:
10+
Do not force push this repository unless you know what you are doing, please use pull requests.

0 commit comments

Comments
 (0)