Skip to content

Commit 5138d30

Browse files
authored
Initial commit
0 parents  commit 5138d30

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

.fernignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Specify files that shouldn't be modified by Fern
2+
3+
README.md
4+
# sample-app/src/main/java/sample/App.java

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# {Company} Java Library
2+
3+
[![Maven Central](https://img.shields.io/maven-central/v/io.github.fern-api/{company})](https://central.sonatype.dev/artifact/io.github.fern-api/{company}/0.0.7/versions)
4+
[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
5+
6+
## Documentation
7+
8+
API documentation is available at <{docs_url}>.
9+
10+
## Usage
11+
12+
Check out the [sample app](.sample-app/app.java) which consumes this SDK!
13+
14+
```java
15+
// start with env variables
16+
TODO
17+
```
18+
19+
## Beta status
20+
21+
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your build.gradle file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
22+
23+
## Contributing
24+
25+
While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
26+
27+
On the other hand, contributions to the README are always very welcome!

0 commit comments

Comments
 (0)