github.com/hyperledger/aries-framework-go@v0.3.2/doc.go (about)

     1  /*
     2  Copyright SecureKey Technologies Inc. All Rights Reserved.
     3  
     4  SPDX-License-Identifier: Apache-2.0
     5  */
     6  
     7  // Package aries enables Go developers to build solutions based on the Hyperledger Aries project
     8  // (https://www.hyperledger.org/projects/aries).
     9  //
    10  // Packages for end developer usage
    11  //
    12  // pkg/framework/aries: The main package of the Aries Framework. This package enables creation of context based on
    13  // provider options. This context is used by the client packages listed below.
    14  // Reference: https://pkg.go.dev/github.com/hyperledger/aries-framework-go/pkg/framework/aries
    15  //
    16  // pkg/client/didexchange: Provides did exchange protocol through SDK.
    17  // Reference: https://pkg.go.dev/github.com/hyperledger/aries-framework-go/pkg/client/didexchange
    18  //
    19  // pkg/controller/restapi/operation/didexchange: Provides did exchange protocol through restapi.
    20  // Reference: https://pkg.go.dev/github.com/hyperledger/aries-framework-go/pkg/controller/restapi/operation/didexchange
    21  //
    22  // Basic workflow
    23  //
    24  //      1) Instantiate a aries instance using a provider options.
    25  //      2) Create a context using your aries instance.
    26  //      3) Create a client instance using its New func, passing the context.
    27  //      4) Use the funcs provided by each client to create your solution!
    28  //      5) Call aries.Close() to release resources.
    29  package aries