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.

Sign up for GitHub

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

Updates in readme documentation #744

Closed
wants to merge 7 commits into from
Closed

Updates in readme documentation #744

Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
de41c3f
changes in readme documentation
shimilgithub Nov 2, 2023
4ed0e20
fixing images
shimilgithub Nov 2, 2023
79a3290
fixing logo
shimilgithub Nov 2, 2023
2320d9e
fixing logo and gif
shimilgithub Nov 2, 2023
3bac68f
removing html code from some parts
shimilgithub Nov 6, 2023
ff409b4
fixing logo
shimilgithub Nov 6, 2023
156aace
fixing logo
shimilgithub Nov 6, 2023
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
17 changes: 8 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@

<h1 align="center">
<br>
<a href="http://www.amitmerchant.com/electron-markdownify"><img src="https://api.vachanengine.org/static/images/Logo.svg" alt="vachanapi" width="200"></a>
<br>
Vachan API
<br>
</h1>
<h4 align="center">Unified API for <a href="https://api.vachanengine.org/" target="_blank">Vachan-Engine applications</a></h4>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't h1 , br be avoided?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I remove h1 tag, logo image goes to left like this. Can I keep like that only or can I use div container to keep image centrally aligned.
Screenshot from 2023-11-06 13-40-04

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about not keeping it centrally aligned? And I dont know what is the point of this much care for formatting a readme file...

<img src="https://api.vachanengine.org/static/images/Logo.svg" alt="vachanapi" width="100"></a>
# VACHAN API

vachanapi

VACHAN API

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And is needed?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have asked to update readme similar to this reference

<p align="center">
•<a href="#implementation-details"> Implementation Details</a> •
<a href="#start-app-with-docker">Start App</a> •
<a href="#set-up-locally-for-development-and-testingwithout-docker">Setup</a> •
<a href="#license">License</a>
</p>




### Unified API for [Vachan-Engine applications](https://api.vachanengine.org/)

[Implementation Details](#implementation-details) • [Start App](#start-app-with-docker) • [Setup](#set-up-locally-for-development-and-testingwithout-docker) • [License](#license)


![screenshot](https://github.com/shimilgithub/vachan-api/blob/de41c3fcc1149a025adcd93ff108a3d786d78818/app/static/images/api_screenshot.gif)
Expand Down Expand Up @@ -107,7 +106,7 @@ Edit the following contents appropriatetly and paste to the `.bashrc` file
export VACHAN_POSTGRES_USER="<db_user>"
export VACHAN_POSTGRES_PASSWORD="<db_password>"
export VACHAN_POSTGRES_DATABASE="<db_name>"
export VACHAN_POSTGRES_DATA_DIR="<data_dirrctory_path>"
export VACHAN_POSTGRES_DATA_DIR="<data_directory_path>"
export VACHAN_LOGGING_LEVEL="WARNING"
export VACHAN_KRATOS_ADMIN_URL="http://127.0.0.1:4434/"
export VACHAN_KRATOS_PUBLIC_URL="http://127.0.0.1:4433/"
Expand Down
Loading