Skip to content

Commit

Permalink
docs: Add promo image
Browse files Browse the repository at this point in the history
  • Loading branch information
cheatsnake committed Feb 11, 2023
1 parent b0b6b02 commit 759be9c
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# Shadify

<a href="https://goreportcard.com/report/github.com/cheatsnake/shadify"><img src="https://goreportcard.com/badge/github.com/cheatsnake/shadify" alt="Go report"/></a>
<a href="https://github.com/cheatsnake/shadify/releases"><img src="https://img.shields.io/github/v/release/cheatsnake/shadify.svg" alt="GitHub repo size"/></a>
<a href="https://img.shields.io/github/repo-size/cheatsnake/shadify?color=blue"><img src="https://img.shields.io/github/repo-size/cheatsnake/shadify?color=blue" alt="GitHub repo size"/></a>
<a href="https://img.shields.io/github/license/cheatsnake/shadify?color=orange"><img src="https://img.shields.io/github/license/cheatsnake/shadify?color=orange" alt="GitHub repo license"/></a>
<a href="https://github.com/cheatsnake/shadify/issues"><img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat" alt="GitHub repo issues"/></a>

# Shadify

Powerful REST API for building puzzles.

## πŸ‘‹ Introduction
<p align="center"><img src="/docs/images/shadify.png" alt="Promo"/></p>

Shadify is a powerful REST API service provides a collection of different puzzle types, like crosswords, Sudoku, word search and so on. The API allows users to generate data for puzzles, check the correctness of solutions, and configure various parameters to change the difficulty of the puzzles.

## πŸ“ƒ Documentation

All docs is available on the [official website](https://shadify.dev). The service is divided into independent modules. Each module starts with a brief description of what the module is oriented at (be it a game, a puzzle, a task, etc.). This is followed by a detailed description of each HTTP interface, with descriptions of the possible parameters and return responses.
All documentation is available on the [official website](https://shadify.dev).

The service is divided into independent modules. Each module starts with a brief description of what the module is oriented at (be it a game, a puzzle, a task, etc.). This is followed by a detailed description of each HTTP interface, with descriptions of the possible parameters and return responses.

- [Sudoku](https://shadify.dev/modules/sudoku.html)
- [Takuzu](https://shadify.dev/modules/takuzu.html)
Expand Down
Binary file added docs/images/shadify.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/introduction.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# πŸ‘‹ Introduction

<p align="center"><img src="../images/shadify.png" alt="Promo"/></p>

Shadify is a powerful REST API service provides a collection of different puzzle types, like crosswords, Sudoku, word search and so on. The API allows users to generate data for puzzles, check the correctness of solutions, and configure various parameters to change the difficulty of the puzzles.

## πŸ‘ Easy to use
Expand Down

0 comments on commit 759be9c

Please sign in to comment.