Skip to content

Commit 65527ca

Browse files
authored
Add README to the managed docs folder (#474)
1 parent 39fd7c5 commit 65527ca

4 files changed

Lines changed: 44 additions & 203 deletions

File tree

.docs/README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
2+
[comment]: # (Start Badges)
3+
4+
[![Join the chat at https://gitter.im/47degrees/github4s](https://badges.gitter.im/47degrees/github4s.svg)](https://gitter.im/47degrees/github4s?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![codecov.io](http://codecov.io/gh/47degrees/github4s/branch/master/graph/badge.svg)](http://codecov.io/gh/47degrees/github4s) [![Maven Central](https://img.shields.io/badge/maven%20central-@VERSION@-green.svg)](https://oss.sonatype.org/#nexus-search;gav~com.47deg~github4s*) [![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://raw.githubusercontent.com/47degrees/github4s/master/LICENSE) [![Latest version](https://img.shields.io/badge/github4s-@VERSION@-green.svg)](https://index.scala-lang.org/47degrees/github4s) [![GitHub Issues](https://img.shields.io/github/issues/47degrees/github4s.svg)](https://github.com/47degrees/github4s/issues)
5+
6+
[comment]: # (End Badges)
7+
8+
Github4s
9+
=============
10+
11+
**Github4s** is a GitHub API wrapper written in Scala.
12+
13+
## Installation
14+
15+
To get started with SBT, simply add the following to your build.sbt file.
16+
17+
[comment]: # (Start Replace)
18+
19+
```scala
20+
libraryDependencies += "com.47deg" %% "github4s" % "@VERSION@"
21+
```
22+
23+
[comment]: # (End Replace)
24+
25+
## Github4s in the wild
26+
27+
If you wish to add your library here please consider a PR to include it in the list below.
28+
29+
★ | ★ | ★
30+
--- | --- | ---
31+
![scala-exercises](https://www.scala-exercises.org/assets/images/navbar_brand.svg) | [**scala-exercises**](https://www.scala-exercises.org/) | Scala Exercises is an Open Source project for learning different technologies based in the Scala Programming Language.
32+
| | [**dashing**](https://github.com/benfradet/dashing) | Dashing is a collection of dashboards to monitor the health of an open source organization.
33+
| | [**cla-bot**](https://github.com/snowplow-incubator/cla-bot) | Bot making sure external contributors sign a CLA.
34+
35+
[comment]: # (Start Copyright)
36+
# Copyright
37+
38+
Github4s is designed and developed by 47 Degrees
39+
40+
Copyright (C) 2016-2020 47 Degrees. <http://47deg.com>
41+
42+
[comment]: # (End Copyright)

LICENSE

Lines changed: 0 additions & 201 deletions
This file was deleted.

build.sbt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
addCommandAlias("ci-test", "+scalafmtCheck; +scalafmtSbtCheck; +docs/mdoc; +test")
2-
addCommandAlias("ci-docs", "project-docs/mdoc; headerCreateAll")
2+
addCommandAlias("ci-docs", "project-docs/mdoc; docs/mdoc; headerCreateAll")
33
addCommandAlias("ci-microsite", "docs/publishMicrosite")
44

55
skip in publish := true

docs/docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ To get started with SBT, simply add the following to your build.sbt file.
1616

1717

1818
```scala mdoc:silent:fail
19-
libraryDependencies += "com.47deg" %% "github4s" % "0.21.0"
19+
libraryDependencies += "com.47deg" %% "github4s" % "@VERSION@"
2020
```

0 commit comments

Comments
 (0)