Skip to content

Commit

Permalink
Merge branch 'main' into dependabot/npm_and_yarn/follow-redirects-1.15.4
Browse files Browse the repository at this point in the history
  • Loading branch information
berendsliedrecht authored Feb 21, 2024
2 parents 34af5f7 + 1586515 commit dd670e4
Show file tree
Hide file tree
Showing 76 changed files with 1,995 additions and 1,202 deletions.
14 changes: 14 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# For details on how this file works refer to:
# - https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
version: 2
updates:
# Maintain dependencies for GitHub Actions
# - Check for updates once a week
# - Group all updates into a single PR
- package-ecosystem: 'github-actions'
directory: '/'
schedule:
interval: 'weekly'
groups:
all-actions:
patterns: ['*']
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 .github/workflows/continuous-integration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ jobs:
name: Check format, types and build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v3
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 16.x
node-version: 18.x
cache: yarn

# ignore scripts as indy-sdk will try to build and we don't have libindy
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ jobs:
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v3
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 16.x
node-version: 18.x
cache: yarn

# ignore scripts as indy-sdk will try to build and we don't have libindy
Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
<p align="center">
<br />
<img
alt="Hyperledger Aries logo"
src="https://raw.githubusercontent.com/hyperledger/aries-framework-javascript/aa31131825e3331dc93694bc58414d955dcb1129/images/aries-logo.png"
alt="Credo logo"
src="https://github.com/openwallet-foundation/credo-ts/blob/c7886cb8377ceb8ee4efe8d264211e561a75072d/images/credo-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 Expand Up @@ -70,7 +70,9 @@ If you are using GitHub pages for hosting, this command is a convenient way to b

The docs are a work in progress, contributions are incredibly appreciated! If you're looking to contribute check out the [contribution guideline](https://github.com/openwallet-foundation/credo-ts-docs/blob/main/CONTRIBUTING.md).

Issues are also welcomed as it gives us a good idea of the work still needing to be done.
There are regular community working groups to discuss ongoing efforts within Credo, showcase items you've built with Credo, or ask questions. See [Meeting Information](https://github.com/openwallet-foundation/credo-ts/wiki/Meeting-Information) for up to date information on the meeting schedule. Everyone is welcome to join!

We welcome you to join our mailing list and Discord channel. See the [Wiki](https://github.com/openwallet-foundation/credo-ts/wiki/Communication) for up to date information.

## Licence

Expand Down
16 changes: 8 additions & 8 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 @@ -70,12 +70,12 @@ const config = {
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
image: 'img/aries-social-preview-layered.png',
image: 'img/credo-social-preview.png',
navbar: {
title: 'Credo Docs',
logo: {
alt: 'Hyperledger Aries Logo',
src: 'img/aries-logo.png',
alt: 'Credo Logo',
src: 'img/credo-logo.png',
},
items: [
{
Expand Down Expand Up @@ -115,12 +115,12 @@ const config = {
href: 'https://discord.com/channels/1022962884864643214/1179453305856991263',
},
{
label: 'Working Group Call Notes',
href: 'https://wiki.hyperledger.org/display/ARIES/Framework+JS+Meetings',
label: 'Mailing List',
href: 'https://lists.openwallet.foundation/g/credo-project',
},
{
label: 'Working Group Call Calendar',
href: 'https://lists.hyperledger.org/login?r=https%3A%2F%2Flists.hyperledger.org%2Fg%2Faries%2Fcalendar',
label: 'Working Group Call Notes',
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 />
10 changes: 5 additions & 5 deletions guides/extensions/push-notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The Push Notifications plugin package provides a way for you to register your AP

:::note

This document is for version **`0.5.x`** of the `@aries-framework/push-notifications` package, that works with `@aries-framework/core` version **`0.4.x`**. Extension packages (such as Push Notifications) are versioned separately from the core packages.
This document is for version **`0.5.x`** of the `@credo-ts/push-notifications` package, that works with `@credo-ts/core` version **`0.4.x`**. Extension packages (such as Push Notifications) are versioned separately from the core packages.

:::

Expand All @@ -17,22 +17,22 @@ To add the Push Notifications plugin package to your existing project simply run
## npm

```sh
npm i @aries-framework/push-notifications
npm i @credo-ts/push-notifications
```

## Yarn

```sh
yarn add @aries-framework/push-notifications
yarn add @credo-ts/push-notifications
```

<!--tabs-->

## Usage

```ts
import { PushNotificationsApnsModule, PushNotificationsFcmModule } from '@aries-framework/push-notifications'
import { } from '@aries-framework/core'
import { PushNotificationsApnsModule, PushNotificationsFcmModule } from '@credo-ts/push-notifications'
import { } from '@credo-ts/core'

const agent = new Agent({
/** agent config... */,
Expand Down
12 changes: 6 additions & 6 deletions guides/extensions/react-hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ These hooks provide a simple way to query agent data in a client application, al

:::note

This document is for version **`0.5.x`** of the `@aries-framework/react-hooks` package, that works with `@aries-framework/core` version **`0.4.x`**. Extension packages (such as React Hooks) are versioned separately from the core packages.
This document is for version **`0.5.x`** of the `@credo-ts/react-hooks` package, that works with `@credo-ts/core` version **`0.4.x`**. Extension packages (such as React Hooks) are versioned separately from the core packages.

:::

Expand All @@ -19,13 +19,13 @@ To add the React Hooks package to your existing project simply run:
## npm

```sh
npm i @aries-framework/react-hooks@^0.5
npm i @credo-ts/react-hooks@^0.5
```

## Yarn

```sh
yarn add @aries-framework/react-hooks@^0.5
yarn add @credo-ts/react-hooks@^0.5
```

<!--/tabs-->
Expand All @@ -47,13 +47,13 @@ import AgentProvider, {
useProofs,
useProofById,
useProofByState,
} from '@aries-framework/react-hooks'
} from '@credo-ts/react-hooks'
```

First step is to wrap your entire app in our `<AgentProvider/>`. The provider takes an initialized agent. The base of your app should look something like this:

```tsx
import AgentProvider from '@aries-framework/react-hooks'
import AgentProvider from '@credo-ts/react-hooks'

const App = () => {
const [agent, setAgent] = useState(undefined)
Expand Down Expand Up @@ -83,7 +83,7 @@ The `useAgent` hook returns `{ agent, loading }` so anytime you need access to a
The following is an example of how you could use the `useConnections` hook to render a full list of all a user's connections.

```ts
import { useConnections } from '@aries-framework/react-hooks'
import { useConnections } from '@credo-ts/react-hooks'

const MyConnectionsComponent = () => {
// all base hooks return an array of objects and a loading boolean
Expand Down
6 changes: 3 additions & 3 deletions guides/extensions/redux-store.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Redux Store allows you to integrate state management for the most important

:::note

This document is for version **`0.4.x`** of the `@aries-framework/redux-store` package, that works with `@aries-framework/core` version **`0.4.x`**. Extension packages (such as Redux Store) are versioned separately from the core packages.
This document is for version **`0.4.x`** of the `@credo-ts/redux-store` package, that works with `@credo-ts/core` version **`0.4.x`**. Extension packages (such as Redux Store) are versioned separately from the core packages.

:::

Expand All @@ -19,13 +19,13 @@ To add the Redux Store package to your existing project simply run:
## npm

```sh
npm i @aries-framework/redux-store
npm i @credo-ts/redux-store
```

## Yarn

```sh
yarn add @aries-framework/redux-store
yarn add @credo-ts/redux-store
```

<!--tabs-->
6 changes: 3 additions & 3 deletions guides/extensions/rest.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The Credo REST API is the most convenient way for self-sovereign identity (SSI)

:::danger

The `@aries-framework/rest` package has not been updated to work with the latest version (**`0.4.x`**) of `@aries-framework/core`. The documentation in this section is for version **`0.9.x`** of the `@aries-framework/rest` package, that works with `@aries-framework/core` version **`0.2.x`**. Extension packages (such as REST API) are versioned separately from the core packages.
The `@credo-ts/rest` package has not been updated to work with the latest version (**`0.4.x`**) of `@credo-ts/core`. The documentation in this section is for version **`0.9.x`** of the `@credo-ts/rest` package, that works with `@credo-ts/core` version **`0.2.x`**. Extension packages (such as REST API) are versioned separately from the core packages.

:::

Expand All @@ -31,7 +31,7 @@ You can do this directly on your machine.
After installing and confirming that Libindy is installed, simply run:

```sh
npx -p @aries-framework/rest afj-rest start \
npx -p @credo-ts/rest credo-rest start \
--label "Credo Rest" \
--wallet-id "walletId" \
--wallet-key "walletKey" \
Expand All @@ -48,5 +48,5 @@ The REST API provides an OpenAPI schema that can easily be viewed using the Swag
To find out all available configuration options from the CLI, you can run the CLI command with `--help`. This will print a full list of all available options.

```sh
npx -p @aries-framework/rest afj-rest start --help
npx -p @credo-ts/rest afj-rest start --help
```
Loading

0 comments on commit dd670e4

Please sign in to comment.