mirror/wakapi
1
0
Fork 0
mirror of https://github.com/muety/wakapi.git synced 2023-08-10 21:12:56 +03:00
Code Issues Projects Releases Wiki Activity

chore: docs and typos

Browse Source
This commit is contained in:
Ferdinand Mütsch 2021-01-22 00:02:56 +01:00
parent e9eaa9da53
commit a3d8c4d464
2 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -36,7 +36,7 @@ To use the hosted version set `api_url = https://wakapi.dev/api/heartbeat`. Howe
* Fedora / RHEL: `dnf install @development-tools` * Fedora / RHEL: `dnf install @development-tools`
* Ubuntu / Debian: `apt install build-essential` * Ubuntu / Debian: `apt install build-essential`
* Windows: See [here](https://github.com/mattn/go-sqlite3/issues/214#issuecomment-253216476) * Windows: See [here](https://github.com/mattn/go-sqlite3/issues/214#issuecomment-253216476)
* _Optional_: A MySQL- or Postgres database * _Optional_: One of the [supported databases](#supported-databases)
**On your local machine:** **On your local machine:**
* [WakaTime plugin](https://wakatime.com/plugins) for your editor / IDE * [WakaTime plugin](https://wakatime.com/plugins) for your editor / IDE
@ -111,9 +111,11 @@ api_key = the_api_key_printed_to_the_console_after_starting_the_server`
You can view your API Key after logging in to the web interface. You can view your API Key after logging in to the web interface.
### Optional: Client-side proxy ### Optional: Client-side proxy
See the [advanced setup instructions](docs/advanced_setup.md). See the [advanced setup instructions](docs/advanced_setup.md).
### Optional: WakaTime relay
You can connect Wakapi with WakaTime in a way that all heartbeats sent to Wakapi are relayed. This way, you can use both services at the same time. Go to the settings page of your instance to configure this integration.
## 🔧 API Endpoints ## 🔧 API Endpoints
The following API endpoints are available. A more detailed Swagger documentation is about to come ([#40](https://github.com/muety/wakapi/issues/40)). The following API endpoints are available. A more detailed Swagger documentation is about to come ([#40](https://github.com/muety/wakapi/issues/40)).

10
views/settings.tpl.html
View File

@ -309,7 +309,7 @@
<div class="mt-10 text-gray-300 text-sm"> <div class="mt-10 text-gray-300 text-sm">
<h3 class="inline-block font-semibold text-md mb-4 border-b border-green-700"> <h3 class="inline-block font-semibold text-md mb-4 border-b border-green-700">
Wakatime WakaTime
</h3> </h3>
<div class="flex space-x-4"> <div class="flex space-x-4">
@ -319,8 +319,8 @@
<p class="text-sm">You can connect Wakapi with the official <a class="underline" <p class="text-sm">You can connect Wakapi with the official <a class="underline"
href="https://wakatime.com" href="https://wakatime.com"
rel="noopener noreferrer" rel="noopener noreferrer"
target="_blank">Wakatime</a> in a way target="_blank">WakaTime</a> in a way
that all heartbeats sent to Wakapi are relayed to Wakatime. This way, you can use both services that all heartbeats sent to Wakapi are relayed. This way, you can use both services
at at
the same time. To get started, <a class="underline" the same time. To get started, <a class="underline"
href="https://wakatime.com/developers#authentication" href="https://wakatime.com/developers#authentication"
@ -330,7 +330,7 @@
<form action="settings/wakatime_integration" method="post"> <form action="settings/wakatime_integration" method="post">
{{ $placeholderText := "Paste your Wakatime API key here ..." }} {{ $placeholderText := "Paste your WakaTime API key here ..." }}
{{ if .User.WakatimeApiKey }} {{ if .User.WakatimeApiKey }}
{{ $placeholderText = "********" }} {{ $placeholderText = "********" }}
{{ end }} {{ end }}
@ -357,7 +357,7 @@
<p class="mt-6"> <p class="mt-6">
<span class="font-semibold">👉 Please note:</span> <span class="font-semibold">👉 Please note:</span>
<span>When enabling this feature, the operators of this server will, in theory (!), have unlimited access to your data stored in Wakatime. If you are concerned about your privacy, please do not enable this integration or wait for OAuth 2 authentication (<a <span>When enabling this feature, the operators of this server will, in theory (!), have unlimited access to your data stored in WakaTime. If you are concerned about your privacy, please do not enable this integration or wait for OAuth 2 authentication (<a
class="underline" target="_blank" href="https://github.com/muety/wakapi/issues/94" rel="noopener noreferrer">#94</a>) to be implemented.</span> class="underline" target="_blank" href="https://github.com/muety/wakapi/issues/94" rel="noopener noreferrer">#94</a>) to be implemented.</span>
</p> </p>
</div> </div>