From 71c5b5eb352a937d10f4158ee8d8144d14dcc014 Mon Sep 17 00:00:00 2001 From: Kiyo <68307546+KiyonoKara@users.noreply.github.com> Date: Sat, 13 Jan 2024 11:23:53 -0500 Subject: [PATCH] Doc: Remove JP readme; will revise this when I revise this --- README_JP.md | 122 --------------------------------------------------- 1 file changed, 122 deletions(-) delete mode 100644 README_JP.md diff --git a/README_JP.md b/README_JP.md deleted file mode 100644 index bd9bedf..0000000 --- a/README_JP.md +++ /dev/null @@ -1,122 +0,0 @@ -# Kukoshi - -
-

- Release Version - Scala Workflow - PRs - Code Size - Last Commit - License -

-
- -「Kukoshi」は、HTTPとHTTPSのリクエストを作るScalaライブラリーです。 -## 纏め -KukoshiはHTTPリクエストの利用を簡単になります。このクライアントはボイラプレートのセッティングや色々なインポートが不必要です。 - -## 機能 -- 圧縮されたデータは、GZIPとDeflateがサポートされている。 -- GET、POST、DELETE、PUT、HEAD、OPTIONS、PATCHソッド可能です。 -- Map` か `Seq` 形式のHEADERをサポートしています（`Iterable[(String, String)]` として適応できるCollectionで動作する） -- `Iterable[(String, String)]` (`Map`、`Seq`)のURLパラメータもできます. -- **ボーナス機能:** - - 外部のライブラリーをダウンロードするのが不要 - - `head`や`options`有り - -## Installation -#### MAIN方法 -TOKENには許可の`read:packages`が必要です。ユーザー名のフィールドは空白ストリングのなるのができます。 -```sbt -credentials += Credentials( - realm = "GitHub Package Registry", - host = "maven.pkg.github.com", - userName = "", - passwd = "" -) - -resolvers += "GitHub Package Registry (KiyonoKara/Kukoshi)" at "https://maven.pkg.github.com/KiyonoKara/Kukoshi" -libraryDependencies += "org.kiyo" %% "kukoshi" % "1.0.0" -``` - -#### 代替のインストール -```sbt -lazy val http = RootProject(uri("git://github.com/KiyonoKara/Kukoshi.git")) -lazy val http_root = project in file(".") dependsOn http -``` - -## 文献集 -書き込み禁止メソッドは一つしかない、どちらが`GET`。`POST`、`DELETE`、`PUT`、`PATCH`は書き込まれますはなるのができます。 - -※ サンプルURLは`https://kukoshi.scala.jp`になります。URLは存在されません。 - -### インポート -ライブラリーの`Request`のクラスをインポートして。 - -```scala -import org.kiyo.Request -``` - -### 表明 -主に、`Request`のクラスを介して使用されます。`Request`のオブジェクトを作り上げます。 -```scala -// Requestのオブジェクト -val requester: Request = new Request() -``` - -任意で、構築子の中URL、METHOD、HEADERSを宣言すできます。 - -### リクエストの作り方 -読み取り専用のリクエストのサンプル -```scala -// METHODなければ、GETを使います。 -// コンストラクタのURLを提供しました。 -val requesterA: Request = new Request(url = "https://kukoshi.scala.jp") -val getA: String = requester.request() - -// 逆に作用できます。 -val requesterB: Request = new Request() -val getB: String = requester.request(url = "https://kukoshi.scala.jp") -``` - -### Headers -`Map`、`Seq`対応しました（`Iterable[(String, String)]`も）。 -```scala -// Map、Seqサンプル -val requesterWithMapHeaders: Request = new Request( - url = "https://kukoshi.scala.jp", - headers = Map("Content-Type" -> "User-Agent" -> "*", "Accept" -> "*/*") -) - -val requesterWithSeqHeaders: Request = new Request( - url = "https://kukoshi.scala.jp", - headers = Seq("Content-Type" -> "User-Agent" -> "*", "Accept" -> "*/*") -) -``` - -### URLのパラメタ -URLパラメタをリクエストに付加する場合、URLパラメタは`request()`にコールの内側にしか付加できないことが可能です。`Iterable[(String, String)]`もできます。 -```scala -// リクエストへの『https://kukoshi.scala.jp?parameter=value』 -val requesterA: Request = new Request() -val requestA: String = requester.request(url = "https://kukoshi.scala.jp", parameters = Map("parameter" -> "value")) - -// リクエストへの『https://kukoshi.scala.jp?parameter1=value1¶meter2=value2』 -val requesterB: Request = new Request() -val requestB: String = requester.request(url = "https://kukoshi.scala.jp", parameters = Map("parameter1" -> "value1", "parameter2" -> "value2")) -``` - -### 書き込み可能なリクエスト -`request()`は書き込み可能リクエスト関数に使われます。 -```scala -// POSTリクエストのサンプル。DELETE、PUT、PATCHは等しいです。 -// ヘッダを入れることができます。 -val requester: Request = new Request() -val POST: String = requester.request(url = "https://kukoshi.scala.jp", method = "POST", data = "{\"key\": \"value\"}") -``` - -## コントリビュートについて -リポジトリをコントリビュートするについては[こちら](CONTRIBUTING.md)です。読んでください。 - -## ライセンス -[Apache 2.0ライセンス](LICENSE.md)