From 6487db12600947cdaff180147d61e3d6741a05a7 Mon Sep 17 00:00:00 2001 From: skantay Date: Sun, 24 Mar 2024 10:42:33 +0600 Subject: [PATCH] uploading --- README.example.md | 19 +++++++++++++++++++ README.md | 20 +++++++------------- 2 files changed, 26 insertions(+), 13 deletions(-) create mode 100644 README.example.md diff --git a/README.example.md b/README.example.md new file mode 100644 index 0000000..d3976db --- /dev/null +++ b/README.example.md @@ -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... \ No newline at end of file diff --git a/README.md b/README.md index 0dc85aa..048b522 100644 --- a/README.md +++ b/README.md @@ -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... \ No newline at end of file +This repo is open for any improvments and discussion.