Skip to content
This repository has been archived by the owner on Dec 12, 2024. It is now read-only.

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
dannysheridan authored Feb 9, 2023
0 parents commit 24c363d
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .fernignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Specify files that shouldn't be modified by Fern

README.md
# sample-app/src/main/java/sample/App.java
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# {Company} Java Library

[![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)
![Sonatype Nexus (Releases)](https://img.shields.io/nexus/r/io.github.fern-api/{company}?server=https%3A%2F%2Fs01.oss.sonatype.org)

## Documentation

API documentation is available at <{docs_url}>.

## Usage

Check out the [sample app](.sample-app/app.java) which consumes this SDK!

```java
// start with env variables
TODO
```

## Beta status

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.

## Contributing

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](https://github.com/fern-{company}/{company}-java/issues) first to discuss with us!

On the other hand, contributions to the README are always very welcome!

0 comments on commit 24c363d

Please sign in to comment.