Mention open source in README

This commit is contained in:
Gregory Schier
2024-09-10 10:29:09 -07:00
parent 7907dcc220
commit e1fdf174c1
2 changed files with 41 additions and 30 deletions

View File

@@ -1,21 +1,21 @@
# Yaak Network Toolkit
# Yaak API Client
The most fun you'll ever have working with APIs.
Yaak is a desktop API client for organizing and executing REST, GraphQL, and gRPC
requests.
## Common Commands
## Feedback and Bug Reports
```sh
# Start dev app
npm run tauri-dev
Please [Create an Issue](https://github.com/yaakapp/app/issues/new) for bug reports and
submit all other feedback to [feedback.yaak.app](https://feedback.yaak.app).
# Migration commands
cd src-tauri
cargo sqlx migrate add ${MIGRATION_NAME}
cargo sqlx migrate run --database-url 'sqlite://db.sqlite?mode=rw'
cargo sqlx prepare --database-url 'sqlite://db.sqlite'
```
## Contribution Policy
## Add App->Plugin API
Yaak was initially closed-source, with no plans of every becoming open
(see [Blog Post](https://yaak.app/blog/why-not-open-source)). However, Open source does
offer many benefits:
- Add event in `events.rs`
- Add handler to `index.worker.ts`
- Full transparency over what is happening
- Code can be audited
- Users can help identify and fix bugs
For these reasons, Yaak is now open source but only accepting contributions for bug fixes.

View File

@@ -8,6 +8,7 @@ import { Checkbox } from '../core/Checkbox';
import { IconButton } from '../core/IconButton';
import { InlineCode } from '../core/InlineCode';
import { HStack } from '../core/Stacks';
import { EmptyStateText } from '../EmptyStateText';
import { SelectFile } from '../SelectFile';
export function SettingsPlugins() {
@@ -17,21 +18,31 @@ export function SettingsPlugins() {
const refreshPlugins = useRefreshPlugins();
return (
<div className="grid grid-rows-[minmax(0,1fr)_auto] h-full">
<table className="w-full text-sm mb-auto min-w-full max-w-full divide-y divide-surface-highlight">
<thead>
<tr>
<th></th>
<th className="py-2 text-left">Plugin</th>
<th className="py-2 text-right">Version</th>
<th></th>
</tr>
</thead>
<tbody className="divide-y divide-surface-highlight">
{plugins.map((p) => (
<PluginInfo key={p.id} plugin={p} />
))}
</tbody>
</table>
{plugins.length === 0 ? (
<div className="pb-4">
<EmptyStateText className="text-center">
Plugins extend the functionality of Yaak.
<br />
Add your first plugin to get started.
</EmptyStateText>
</div>
) : (
<table className="w-full text-sm mb-auto min-w-full max-w-full divide-y divide-surface-highlight">
<thead>
<tr>
<th></th>
<th className="py-2 text-left">Plugin</th>
<th className="py-2 text-right">Version</th>
<th></th>
</tr>
</thead>
<tbody className="divide-y divide-surface-highlight">
{plugins.map((p) => (
<PluginInfo key={p.id} plugin={p} />
))}
</tbody>
</table>
)}
<form
onSubmit={(e) => {
e.preventDefault();