Skip to content

Commit

Permalink
refactor: rename leftovers (#144)
Browse files Browse the repository at this point in the history
Signed-off-by: Karim Stekelenburg <karim@animo.id>
  • Loading branch information
karimStekelenburg authored Jan 30, 2024
1 parent 013aaf0 commit 6cf2e35
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 26 deletions.
2 changes: 1 addition & 1 deletion .github/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

repository:
name: credo-ts-docs
description: Extension libraries for Credo
description: Documentation for Credo
homepage: https://github.com/openwallet-foundation/credo-ts-docs
default_branch: main
has_downloads: false
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
<br />
<img
alt="Hyperledger Aries logo"
src="https://raw.githubusercontent.com/hyperledger/aries-framework-javascript/aa31131825e3331dc93694bc58414d955dcb1129/images/aries-logo.png"
src="https://raw.githubusercontent.com/openwallet-foundation/credo-ts/aa31131825e3331dc93694bc58414d955dcb1129/images/aries-logo.png"
height="250px"
/>
</p>
<h1 align="center"><b>Credo Documentation</b></h1>
<p align="center">
<a
href="https://raw.githubusercontent.com/hyperledger/aries-framework-javascript/main/LICENSE"
href="https://raw.githubusercontent.com/openwallet-foundation/credo-ts/main/LICENSE"
><img
alt="License"
src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"
Expand All @@ -22,7 +22,7 @@
<a href="#license">License</a>
</p>

Credo is an ecosystem of self-sovereign identity development tools, with [Credo](https://github.com/openwallet-foundation/credo-ts) at the center. This documentation site serves to make it as easy as possible for developers of any level to get started with building self-sovereign identity solutions.
[Credo](https://github.com/openwallet-foundation/credo-ts) is a modular ecosystem of self-sovereign identity development tools written in TypeScript. This documentation site serves to make it as easy as possible for developers of any level to get started with building self-sovereign identity solutions.

# Getting Started

Expand Down
8 changes: 2 additions & 6 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const remarkTabs = require('remark-docusaurus-tabs')
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Credo',
tagline: 'Everything you need to know about the Credo TS ecosystem.',
tagline: 'Everything you need to know about the Credo ecosystem.',
url: 'https://credo.js.org',
baseUrl: '/',
onBrokenLinks: 'warn',
Expand Down Expand Up @@ -116,11 +116,7 @@ const config = {
},
{
label: 'Working Group Call Notes',
href: 'https://wiki.hyperledger.org/display/ARIES/Framework+JS+Meetings',
},
{
label: 'Working Group Call Calendar',
href: 'https://lists.hyperledger.org/login?r=https%3A%2F%2Flists.hyperledger.org%2Fg%2Faries%2Fcalendar',
href: 'https://github.com/openwallet-foundation/credo-ts/wiki/Meeting-Information',
},
],
},
Expand Down
3 changes: 1 addition & 2 deletions guides/concepts/agents.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Agents

When working with any Credo implementation, you will interact with an Credo
agent. This will be either directly or via a REST API, like [the Credo
framework REST
agent. This will be either directly or via a REST API, like [the Credo REST
API](https://github.com/openwallet-foundation/credo-ts-ext/tree/main/packages/rest).

### Characteristics
Expand Down
12 changes: 6 additions & 6 deletions guides/extensions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Credo Extensions is an extensions repository to Credo. It hosts libraries built

Currently, there are four packages in the extension repository. Example extension libraries include React Hooks for Credo and a REST API wrapper.

| Package | Version | Description |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
| [`@aries-framework/redux-store`](https://www.npmjs.com/package/@aries-framework/redux-store) | ![@aries-framework/redux-store version](https://img.shields.io/npm/v/@aries-framework/redux-store) | Redux toolkit wrapper around Credo |
| [`@aries-framework/rest`](https://www.npmjs.com/package/@aries-framework/rest) | ![@aries-framework/rest version](https://img.shields.io/npm/v/@aries-framework/rest) | Rest endpoint wrapper for using your agent over HTTP |
| [`@aries-framework/react-hooks`](https://www.npmjs.com/package/@aries-framework/react-hooks) | ![@aries-framework/react-hooks version](https://img.shields.io/npm/v/@aries-framework/react-hooks) | React Hooks for data handling and agent interaction |
| [`@aries-framework/push-notifications`](https://www.npmjs.com/package/@aries-framework/push-notifications) | ![@aries-framework/push-notifications version](https://img.shields.io/npm/v/@aries-framework/push-notifications) | Push notification plugin for Credo |
| Package | Version | Description |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
| [`@credo-ts/redux-store`](https://www.npmjs.com/package/@credo-ts/redux-store) | ![@credo-ts/redux-store version](https://img.shields.io/npm/v/@credo-ts/redux-store) | Redux toolkit wrapper around Credo |
| [`@credo-ts/rest`](https://www.npmjs.com/package/@credo-ts/rest) | ![@credo-ts/rest version](https://img.shields.io/npm/v/@credo-ts/rest) | Rest endpoint wrapper for using your agent over HTTP |
| [`@credo-ts/react-hooks`](https://www.npmjs.com/package/@credo-ts/react-hooks) | ![@credo-ts/react-hooks version](https://img.shields.io/npm/v/@credo-ts/react-hooks) | React Hooks for data handling and agent interaction |
| [`@credo-ts/push-notifications`](https://www.npmjs.com/package/@credo-ts/push-notifications) | ![@credo-ts/push-notifications version](https://img.shields.io/npm/v/@credo-ts/push-notifications) | Push notification plugin for Credo |

<DocCardList />
11 changes: 4 additions & 7 deletions guides/tutorials/agent-config/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Agent Config

The Aries agent provided by [Aries Framework
JavaScript](https://github.com/openwallet-foundation/credo-ts) is very
extensible. These are all the configuration options with a short description:
The Credo agent is very extensible. These are all the configuration options with a short description:

## `label`\*

Expand Down Expand Up @@ -127,7 +125,7 @@ that can be used for simple logs. See [Logging](./logging) for more details on c
**Type**: `Logger`

```typescript title="example"
import { ConsoleLogger, LogLevel } from '@aries-framework/core'
import { ConsoleLogger, LogLevel } from '@credo-ts/core'

logger: new ConsoleLogger(LogLevel.info)
```
Expand Down Expand Up @@ -155,7 +153,7 @@ much more ambiguous in their specification.
&nbsp;&nbsp;&nbsp; "application/didcomm-envelope-enc"

```typescript title="example"
import { DidCommMimeType } from '@aries-framework/core'
import { DidCommMimeType } from '@credo-ts/core'

didCommMimeType: DidCommMimeType.V1
```
Expand Down Expand Up @@ -207,8 +205,7 @@ connectionImageUrl: 'https://picsum.photos/200'
## `autoUpdateStorageOnStartup`

Whether the storage should automatically be updated when a newer version of
[Aries Framework
JavaScript](https://github.com/openwallet-foundation/credo-ts) is used.
[Credo](https://github.com/openwallet-foundation/credo-ts) is used.

**Type**: `boolean`

Expand Down
2 changes: 1 addition & 1 deletion guides/tutorials/agent-config/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ agentDependencies.indy.setLogger((level, target, message, modulePath, file, line
> WARNING: You can only set the logger once. Call indy_set_default_logger, indy_set_logger, not both. Once it's been set, libindy won't let you change it.
You can also set the environment variable `RUST_LOG` to log at specified log levels.
See <https://crates.io/crates/env_logger> for more information.
See https://crates.io/crates/env_logger for more information.

0 comments on commit 6cf2e35

Please sign in to comment.