Skip to content

Commit 84b4e66

Browse files
feat(readme): create initial readme
1 parent bc8908e commit 84b4e66

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<h1 align="center">SAMT - Simple API Modeling Toolkit</h1>
2+
3+
<div align="center">
4+
5+
[![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)
6+
[![Total Downloads on GitHub](https://img.shields.io/github/downloads/samtkit/core/total)](https://github.com/samtkit/core/releases/latest)
7+
[![MIT License](https://img.shields.io/github/license/samtkit/core)](./LICENSE)
8+
9+
</div>
10+
11+
<p align="center">
12+
<i>Tired of unreadable OpenAPI YAML files and a plethora of different tools?
13+
<br>SAMT is a developer-focussed, extendable and easy-to-learn toolkit for modeling APIs using a business-first approach</i>
14+
<br>
15+
</p>
16+
17+
<hr>
18+
19+
## Documentation
20+
21+
Get started with SAMT, learn fundamental concepts or extend SAMT with a custom generator.
22+
23+
- [Getting Started](https://github.com/samtkit/core/wiki/Getting-Started)
24+
- [Modeling Concepts](https://github.com/samtkit/core/wiki/Modeling-Concepts)
25+
- [Visual Studio Code Plugin](https://marketplace.visualstudio.com/items?itemName=samt.samt)
26+
27+
### Advanced
28+
29+
- [Authoring Generators](https://github.com/samtkit/core/wiki/Authoring-Generators)
30+
- [Architecture](https://github.com/samtkit/core/wiki/Architecture)
31+
32+
## Development Setup
33+
34+
## Contributing
35+
36+
Want to report a bug, contribute code, or improve documentation? Excellent! Simply create
37+
an [issue](https://github.com/samtkit/core/issues), open a [pull request](https://github.com/samtkit/core/pulls) or
38+
start a [discussion](https://github.com/samtkit/core/discussions).

0 commit comments

Comments
 (0)