Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(google-automations): fix the package name in README #1792

Merged
merged 1 commit into from
May 19, 2021
Merged

docs(google-automations): fix the package name in README #1792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/bot-config-utils/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This is a small library for handling bot config file.
## Install

```bash
npm i @github-automations/bot-config-utils
npm i @google-automations/bot-config-utils
```

## Get the config
Expand All @@ -16,7 +16,7 @@ interface. The code assumes we're in the probot handler.
```typescript
import {
getConfig,
} from '@github-automations/bot-config-utils';
} from '@google-automations/bot-config-utils';

interface Config {
myConfig: string;
Expand All @@ -38,7 +38,7 @@ You can use a similar method that supports default value.
```typescript
import {
getConfigWithDefault,
} from '@github-automations/bot-config-utils';
} from '@google-automations/bot-config-utils';

interface Config {
myConfig: string;
Expand Down Expand Up @@ -88,7 +88,7 @@ You also need to provide a schema definition. Here is an example definition:

Here is a sample handler(this assumes you're developping a Probot app):
```typescript
import {ConfigChecker} from '@github-automations/bot-config-utils';
import {ConfigChecker} from '@google-automations/bot-config-utils';
import schema from './config-schema.json';

// ...
Expand Down
4 changes: 2 additions & 2 deletions packages/datastore-lock/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ library allows the bot to acquire a lock on sth.
### Install

```bash
npm i @github-automations/datastore-lock
npm i @google-automations/datastore-lock
```

### Usage

```typescript
import {DatastoreLock} from '@github-automations/datastore-lock';
import {DatastoreLock} from '@google-automations/datastore-lock';

// Most of the cases, you can just pass `lockId` and `target`.
// `lockId` is usually the bot name.
Expand Down