feat: clean up readme and code of conduct (#382)

Author: nyurik

CODE_OF_CONDUCT.md

@@ -1,46 +1,3 @@
-# Contributor Covenant Code of Conduct
+# Code of conduct
 
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at hello@urbica.co. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/maplibre/maplibre/blob/main/CODE_OF_CONDUCT.md)

README.md

@@ -50,7 +50,7 @@ Martin requires PostGIS >= 2.4.0.
 You can download martin from [Github releases page](https://github.com/maplibre/martin/releases).
 
 | Platform | Downloads (latest)      |
-| -------- | ----------------------- |
+|----------|-------------------------|
 | Linux    | [64-bit][rl-linux-tar]  |
 | macOS    | [64-bit][rl-macos-tar]  |
 | Windows  | [64-bit][rl-winx64-zip] |
@@ -87,7 +87,7 @@ Martin provides [TileJSON](https://github.com/mapbox/tilejson-spec) endpoint for
 When started, martin will go through all spatial tables and functions with an appropriate signature in the database. These tables and functions will be available as the HTTP endpoints, which you can use to query Mapbox vector tiles.
 
 | Method | URL                                                                              | Description                                             |
-| ------ | -------------------------------------------------------------------------------- | ------------------------------------------------------- |
+|--------|----------------------------------------------------------------------------------|---------------------------------------------------------|
 | `GET`  | `/index.json`                                                                    | [Table Sources List](#table-sources-list)               |
 | `GET`  | `/{schema_name}.{table_name}.json`                                               | [Table Source TileJSON](#table-source-tilejson)         |
 | `GET`  | `/{schema_name}.{table_name}/{z}/{x}/{y}.pbf`                                    | [Table Source Tiles](#table-source-tiles)               |
@@ -409,12 +409,12 @@ Options:
 
 You can also configure martin using environment variables
 
-| Environment variable          | Example                            | Description                                   |
-| ----------------------------- | ---------------------------------- | --------------------------------------------- |
-| `DATABASE_URL`                | `postgres://postgres@localhost/db` | Postgres database connection                  |
-| `CA_ROOT_FILE`                | `./ca-certificate.crt`             | Loads trusted root certificates from a file   |
-| `DEFAULT_SRID`                | `4326`                             | Fallback SRID                                 |
-| `DANGER_ACCEPT_INVALID_CERTS` | `false`                            | Trust invalid certificates                    |
+| Environment variable          | Example                            | Description                                 |
+|-------------------------------|------------------------------------|---------------------------------------------|
+| `DATABASE_URL`                | `postgres://postgres@localhost/db` | Postgres database connection                |
+| `CA_ROOT_FILE`                | `./ca-certificate.crt`             | Loads trusted root certificates from a file |
+| `DEFAULT_SRID`                | `4326`                             | Fallback SRID                               |
+| `DANGER_ACCEPT_INVALID_CERTS` | `false`                            | Trust invalid certificates                  |
 
 ## Configuration File
 
@@ -575,7 +575,7 @@ services:
     image: urbica/martin
     restart: unless-stopped
     ports:
-      - 3000:3000
+      - "3000:3000"
     environment:
       - DATABASE_URL=postgres://postgres:password@db/db
     depends_on:
@@ -618,7 +618,7 @@ services:
     image: nginx:alpine
     restart: unless-stopped
     ports:
-      - 80:80
+      - "80:80"
     volumes:
       - ./cache:/var/cache/nginx
       - ./nginx.conf:/etc/nginx/nginx.conf:ro
@@ -782,26 +782,26 @@ You can use martin with [Managed PostgreSQL from DigitalOcean](https://www.digit
 
 First, you need to download the CA certificate and get your cluster connection string from the [dashboard](https://cloud.digitalocean.com/databases). After that, you can use the connection string and the CA certificate to connect to the database
 
-```
+```shell
 martin --ca-root-file ./ca-certificate.crt postgres://user:password@host:port/db?sslmode=require
 ```
 
 ### Using with Heroku PostgreSQL
 
 You can use martin with [Managed PostgreSQL from Heroku](https://www.heroku.com/postgres) with PostGIS extension
 
-```
+```shell
 heroku pg:psql -a APP_NAME -c 'create extension postgis'
 ```
 
 In order to trust the Heroku certificate, you can disable certificate validation with either `DANGER_ACCEPT_INVALID_CERTS` environment variable
 
-```
+```shell
 DATABASE_URL=$(heroku config:get DATABASE_URL -a APP_NAME) DANGER_ACCEPT_INVALID_CERTS=true martin
 ```
 
 or `--danger-accept-invalid-certs` command-line argument
 
-```
+```shell
 martin --danger-accept-invalid-certs $(heroku config:get DATABASE_URL -a APP_NAME)
 ```