Skip to content

Commit

Permalink
feat(readme): create initial readme
Browse files Browse the repository at this point in the history
  • Loading branch information
PascalHonegger committed Apr 28, 2023
1 parent bc8908e commit 84b4e66
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<h1 align="center">SAMT - Simple API Modeling Toolkit</h1>

<div align="center">

[![Latest Stable Release on GitHub](https://img.shields.io/github/v/release/samtkit/core?display_name=tag&sort=semver)](https://github.com/samtkit/core/releases/latest)
[![Total Downloads on GitHub](https://img.shields.io/github/downloads/samtkit/core/total)](https://github.com/samtkit/core/releases/latest)
[![MIT License](https://img.shields.io/github/license/samtkit/core)](./LICENSE)

</div>

<p align="center">
<i>Tired of unreadable OpenAPI YAML files and a plethora of different tools?
<br>SAMT is a developer-focussed, extendable and easy-to-learn toolkit for modeling APIs using a business-first approach</i>
<br>
</p>

<hr>

## Documentation

Get started with SAMT, learn fundamental concepts or extend SAMT with a custom generator.

- [Getting Started](https://github.com/samtkit/core/wiki/Getting-Started)
- [Modeling Concepts](https://github.com/samtkit/core/wiki/Modeling-Concepts)
- [Visual Studio Code Plugin](https://marketplace.visualstudio.com/items?itemName=samt.samt)

### Advanced

- [Authoring Generators](https://github.com/samtkit/core/wiki/Authoring-Generators)
- [Architecture](https://github.com/samtkit/core/wiki/Architecture)

## Development Setup

## Contributing

Want to report a bug, contribute code, or improve documentation? Excellent! Simply create
an [issue](https://github.com/samtkit/core/issues), open a [pull request](https://github.com/samtkit/core/pulls) or
start a [discussion](https://github.com/samtkit/core/discussions).

0 comments on commit 84b4e66

Please sign in to comment.