Skip to content

Commit

Permalink
Update README with basic stuff (#17)
Browse files Browse the repository at this point in the history
  • Loading branch information
carstingaxion authored Feb 24, 2024
2 parents fee28d7 + 0fbab8d commit 6e8d306
Showing 1 changed file with 9 additions and 33 deletions.
42 changes: 9 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,36 +27,19 @@
This is the long desc

* [x] *list closed tracking-issues or `docs` files here*
* [ ] Do you have any [ideas](/issues/new) ?
* [ ] Do you have any [ideas](https://github.com/figuren-theater/ft-seo/issues/new) ?

## Background & Motivation

...

## Install

1. Add this repository to your `composer.json`
```json
"repositories": [
{
"type": "git",
"url": "https://github.com/figuren-theater/ft-seo"
}
]
```
1. Install via command line
```sh
composer require figuren-theater/ft-seo
```

2. Install via command line
```sh
composer require figuren-theater/ft-seo
```

## Usage

### API

```php
Figuren_Theater::API\get_...()
```

## Plugins included

Expand All @@ -66,19 +49,12 @@ Thoose are completely managed by code and lack of their typical UI.
* [Yoast SEO](https://wordpress.org/plugins/wordpress-seo/#developers)
* [Sharing Image](https://wordpress.org/plugins/sharing-image/#developers)

---

## What does this package do in addition?

Accompaniying the core functionality of the mentioned plugins, theese **best practices** are included with this package.

* ...


## Built with & uses

- [dependabot](/.github/dependabot.yml)
- ....
- [code-quality](https://github.com/figuren-theater/code-quality/) A set of status checks to ensure high and consitent code-quality for the figuren.theater platform.
- ...

## Contributing

Expand All @@ -97,13 +73,13 @@ Don't forget to give the project a star! Thanks again!
## Versioning
We use [Semantic Versioning](http://semver.org/) for versioning. For the versions
available, see the [tags on this repository](/tags).
available, see the [tags on this repository](https://github.com/figuren-theater/ft-seo/tags).
## Authors
- **Carsten Bach** - *Provided idea & code* - [figuren.theater/crew](https://figuren.theater/crew/)
See also the list of [contributors](/contributors)
See also the list of [contributors](https://github.com/figuren-theater/ft-seo/contributors)
who participated in this project.
## License
Expand Down

0 comments on commit 6e8d306

Please sign in to comment.