Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

uploading #7

Merged
merged 1 commit into from
Mar 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# {PROJECT NAME}

- description
- used technologies
- a little more precise description

# Getting Started

- instruction on how to start

# Usage

- list/show available commands

# Docs

- swagger
- erm
- etc...
20 changes: 7 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,13 @@
# {PROJECT NAME}
# REST API - template

- description
- used technologies
- a little more precise description
For who ?

# Getting Started
This template is made for developers who are involved in REST API projects.

- instruction on how to start
Why ?

# Usage
[ba](https://en.wikipedia.org/wiki/Brainfuck)
- list/show available commands
Starting from scratch consumes time, which could be used for coding, but it's not the main point of this template. The main point is that your REST APIs will be standardized, so it gives you a flexibility when rotating between projects.

# Docs
I do not like the way you did this ... Can I contribute ?

- swagger
- erm
- etc...
This repo is open for any improvments and discussion.
Loading