@rockcarver/frodo-lib 0.11.0

package/CHANGELOG.md

@@ -0,0 +1,512 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.11.0] - 2022-08-16
+
+### Changed
+
+-   \#1: Split frodo into frodo-lib and frodo-cli
+-   \#5: Removed all cli artifacts
+-   \#2: Made frodo-lib a true library
+-   \#3: Updated pipeline to build the library package
+
+## [0.10.4] - 2022-08-13
+
+### Added
+
+-   \#376: Frodo is now being published as an npm package: @rockcarver/frodo-cli.
+-   \#317: Binary archive names now include the release version.
+-   \#369: Added backwards compatibilty with node 16 and 14. Binaries are still built using the latest node version (18). Smoke tests run against all supported versions (18, 16, 14).
+
+### Fixed
+
+-   \#368: Progress bar no longer overrides verbose output on journey import.
+
+## [0.10.3] - 2022-08-13 [YANKED]
+
+## [0.10.2] - 2022-08-13 [YANKED]
+
+## [0.10.1] - 2022-08-13 [YANKED]
+
+## [0.10.0] - 2022-08-13 [YANKED]
+
+## [0.9.3-7] - 2022-08-13 [YANKED]
+
+## [0.9.3-6] - 2022-08-13 [YANKED]
+
+## [0.9.3-5] - 2022-08-13 [YANKED]
+
+## [0.9.3-4] - 2022-08-13 [YANKED]
+
+## [0.9.3-3] - 2022-08-13 [YANKED]
+
+## [0.9.3-2] - 2022-08-13 [YANKED]
+
+## [0.9.3-1] - 2022-08-13 [YANKED]
+
+## [0.9.3-0] - 2022-08-12 [YANKED]
+
+## [0.9.2] - 2022-08-11
+
+### Added
+
+-   \#205: Added `--no-deps` option to `journey export`/`import` commands. This allows users to omit all external dependencies from a journey export and/or import. One use case where this comes in handy is when using frodo as a CI/CD tool to extract and deploy individual configuration artifacts and it is desirable to not mingle multiple types of configuration in a single file but keep each type of configuration in its own file for version and change control.
+-   Added `--verbose` option to `journey export` command.
+-   \#341: Added initial smoke tests to validate basic functionality.
+
+### Changed
+
+-   \#363: Frodo now performs dependency resolution and reports unresolved dependencies on single journey imports.
+-   \#364: Frodo now uses a spinner and no longer a progress bar to indicate progress on single journey imports.
+-   Internal restructuring (#158, #159, #164, #165)
+-   Updated PIPELINE.md with latest pipeline changes
+
+### Fixed
+
+-   \#359: Frodo now properly exports themes from forgeops deployments.
+-   \#362: Frodo now properly imports journeys with email templates.
+-   \#357: Frodo no longer throws an error and exits occasionally when running the `frodo log tail` command.
+-   \#355: Frodo now properly imports social IDPs into 7.1 environments when using the `frodo journey import` command.
+-   \#353: Frodo now properly imports social IDPs when using the `frodo journey import` command.
+-   \#351: Frodo now properly shows IDM messages using the `frodo logs tail` command.
+-   \#349: Frodo now properly exports journeys from classic deployments
+
+## [0.9.2-12] - 2022-08-09
+
+### Fixed
+
+-   \#359: Frodo now properly exports themes from forgeops deployments.
+
+## [0.9.2-11] - 2022-08-09
+
+### Changed
+
+-   \#363: Frodo now performs dependency resolution and reports unresolved dependencies on single journey imports.
+-   \#364: Frodo now uses a spinner and no longer a progress bar to indicate progress on single journey imports.
+
+### Fixed
+
+-   \#362: Frodo now properly imports journeys with email templates.
+
+## [0.9.2-10] - 2022-08-05
+
+### Fixed
+
+-   \#357: Frodo no longer throws an error and exits occasionally when running the `frodo log tail` command.
+
+## [0.9.2-9] - 2022-07-30
+
+### Fixed
+
+-   \#355: Frodo now properly imports social IDPs into 7.1 environments when using the `frodo journey import` command.
+
+## [0.9.2-8] - 2022-07-28
+
+### Fixed
+
+-   \#353: Frodo now properly imports social IDPs when using the `frodo journey import` command.
+
+## [0.9.2-7] - 2022-07-28
+
+### Fixed
+
+-   \#351: Frodo now properly shows IDM messages using the `frodo logs tail` command.
+
+## [0.9.2-6] - 2022-07-27
+
+### Fixed
+
+-   \#349: Frodo now properly exports journeys from classic deployments
+
+## [0.9.2-5] - 2022-07-23
+
+### Changed
+
+-   Internal restructuring (#158, #159, #164, #165)
+
+## [0.9.2-4] - 2022-07-22
+
+### Added
+
+-   \#341: Added initial smoke tests to validate basic functionality
+
+### Changed
+
+-   Updated PIPELINE.md with latest pipeline changes
+
+## [0.9.2-3] - 2022-07-22 [YANKED]
+
+## [0.9.2-2] - 2022-07-22 [YANKED]
+
+## [0.9.2-1] - 2022-07-22 [YANKED]
+
+## [0.9.2-0] - 2022-07-22 [YANKED]
+
+## [0.9.1] - 2022-07-21
+
+### Added
+
+-   \#311: Added explicit support for network proxies (`HTTPS_PROXY=<protocol>://<host>:<port>`)
+    Frodo now supports using system enviroment variable `HTTPS_PROXY` (and `HTTP_PROXY`) to connect through a network proxy.
+
+### Changed
+
+-   Changes to `frodo realm describe` command:
+    -   The realm argument now exclusively determines the realm
+    -   Removed `-n`/`--name` parameter
+-   Internal restructuring (#167)
+
+### Fixed
+
+-   \#329: Fixed help info for `esv apply` command
+-   \#335: Fixed error when running `idm list` command
+-   \#338: Frodo now successfully authenticates with or without using a proxy
+
+## [0.9.1-1] - 2022-07-21
+
+### Fixed
+
+-   \#338: Frodo now successfully authenticates with or without using a proxy
+
+## [0.9.1-0] - 2022-07-21 [YANKED]
+
+## [0.9.0] - 2022-07-21 [YANKED]
+
+## [0.8.2] - 2022-07-17
+
+### Changed
+
+-   Changed `idm` sub-commands to align with other commands:
+    -   The sub-commands `export`, `exportAll`, and `exportAllRaw` have been collapsed into one: `export`
+        -   `idm export -A` (`--all-separate`) is now the way to export all idm configuration. 
+            -   Options `-e` and `-E` select old `exportAll` functionality with variable replacement and filtering
+            -   Omitting options `-e` and `-E`,  selects the old `exportAllRaw` functionality without variable replacement and without filtering
+    -   Renamed sample resource files for `idm export` command:
+        -   `<frodo home>/resources/sampleEntitiesFile.json`
+        -   `<frodo home>/resources/sampleEnvFile.env`
+    -   The `-N`/`--name` option of the count command has been renamed to `-m`/`--managed-object`
+-   Internal restructuring (#137)
+
+### Fixed
+
+-   \#325: Frodo now gracefully reports and skips node types causing errors during pruning
+-   \#331: Frodo now correctly counts managed objects when using the `idm count` command
+
+## [0.8.2-1] - 2022-07-16
+
+### Fixed
+
+-   \#325: Frodo now gracefully reports and skips node types causing errors during pruning
+
+## [0.8.2-0] - 2022-07-16 [YANKED]
+
+## [0.8.1] - 2022-07-15
+
+### Added
+
+-   New `-l`/`--long` option to script list command
+
+### Changed
+
+-   Changed default behavior of `frodo conn add` to validate connection details by default and renamed parameter from `--validate` to `--no-validate` to allow disabling validation
+-   Internal restructuring (#169)
+
+### Fixed
+
+-   \#324: Frodo now includes themes assigned at journey level in journey exports
+
+## [0.8.1-0] - 2022-07-14 [YANKED]
+
+## [0.8.0] - 2022-07-13
+
+### Added
+
+-   \#320: Frodo now identifies itself through the User-Agent header `<name>/<version>` (e.g. `frodo/0.7.1-1`)
+
+### Changed
+
+-   Renamed `realm details` to `realm describe` but registered `realm details` as an alias for backwards compatibility
+-   Changes to application command
+    -   Renamed command to `app` but registered `application` as an alias for backwards compatibility
+    -   Renamed option `-i`/`--id` to `-i`/`--app-id`. Short version is not impacted by rename.
+-   Internal restructuring (#133, #134, #141 #142, #146)
+
+### Fixed
+
+-   \#319: frodo admin create-oauth2-client-with-admin-privileges --llt properly handles name collisions
+
+## [0.7.1-1] - 2022-07-11
+
+## [0.7.1-0] - 2022-07-10
+
+## [0.7.0] - 2022-07-10
+
+### Added
+
+-   CHANGELOG.md
+-   `conn describe` command to describe connection profiles
+    -   `--show-secrets` option to `conn describe` command to show clear-text secrets
+-   `--validate` option to `conn add` command to validate credentials before adding
+
+### Changed
+
+-   Adapted true semantic versioning
+-   Pipeline changes
+    -   Automated updating changelog using keep a changelog format in CHANGELOG.md
+    -   Automated version bump (SemVer format) using PR comments to trigger prerelease, patch, minor, or major bumps
+    -   Automated release notes extraction from CHANGELOG.md
+    -   Automated GitHub release creation
+    -   Renamed frodo.yml to pipeline.yml
+-   Renamed connections command to `conn` with aliases `connection` and `connections` for backwards compatibility
+-   Internal restructuring (#160, #135)
+
+### Fixed
+
+-   \#280: Fixed missing -k/--insecure param in application sub-commands #280
+-   \#310: No longer storing connection profiles unless explicitly instructed to
+
+## [0.6.4-4] - 2022-07-10 [YANKED]
+
+## [0.6.4-3] - 2022-07-09 [YANKED]
+
+## [0.6.4-2] - 2022-07-09 [YANKED]
+
+## [0.6.4-1] - 2022-07-09 [YANKED]
+
+## [0.6.4-0] - 2022-07-09 [YANKED]
+
+## [0.6.3] - 2022-07-08 [YANKED]
+
+## 0.6.3-alpha.1 - 0.6.3-alpha.51 [YANKED]
+
+## 0.6.2 [YANKED]
+
+## 0.6.1 alpha 26 - 2022-06-28
+
+### Changed
+
+-   Changed archive step of Windows binary build to use 7zip
+
+## 0.6.1 alpha 22 - 0.6.1 alpha 25 [YANKED]
+
+## 0.6.1 alpha 21 - 2022-06-27
+
+### Added
+
+-   Added theme delete command
+-   Theme list e2e tests
+-   Theme delete e2e tests
+-   Added esv command
+    -   esv secret - Manage secrets.
+    -   esv variable - Manage variables.
+    -   esv apply - Apply pending changes.
+-   Updated all dependencies to the latest versions
+
+### Changed
+
+-   Moved secret command under new esv command
+
+## 0.6.1 alpha 20 - 2022-06-23
+
+### Added
+
+-   Added journey delete command
+-   journey list e2e tests
+-   journey delete e2e tests
+
+### Changed
+
+-   Allow progressbar output to be captured in redirects
+
+### Fixed
+
+-   Journey import fixes
+-   Journey export bug fix
+-   Fix theme import issues when using /alpha or /bravo instead of alpha or bravo
+-   Fix admin create-oauth2-client-with-admin-privileges command
+
+## 0.6.1 alpha 19 - 2022-06-14
+
+### Added
+
+-   First stab at e2e testing of journey command
+-   saml command enhancements
+
+### Fixed
+
+-   Detect and remove invalid tree attributes on import
+-   Fixed issue where overriding deployment type would fail to detect the default realm
+-   Fix theme import -A
+
+## 0.6.1 alpha 18 - 2022-06-10
+
+### Added
+
+-   \--txid parameter with the logs commands to filter log output by transactionId
+
+### Fixed
+
+-   Bug in idm exportAllRaw
+
+## 0.6.1 alpha 17 - 2022-06-08
+
+### Added
+
+-   New saml command to manage entity providers and circles of trust
+
+### Changed
+
+-   Updates to journey export/import commands
+    -   Support for social identity providers
+    -   Support for themes
+    -   Support for SAML entity providers
+    -   Support for SAML circles of trust
+    -   Breaking changes in journey sub-commands
+        -   export
+            -   \-t/--tree renamed to -i/--journey-id
+        -   import
+            -   \-t/--tree renamed to -i/--journey-id
+            -   \-i/--journey-id is now only used to select the journey to import if there are multiple journeys in the import file
+            -   \-n (No re-UUID) removed
+            -   new flag --re-uuid with inversed behavior of removed -n flag. Frodo by default no longer generates new UUIDs for nodes on import
+-   Scalability enhancements to journey prune command. The changes allow the prune command to scale to many thousands of orphaned node configuration objects in an AM instance
+-   Updated readme
+-   Miscellaneous bug fixes
+
+## 0.6.1 alpha 14 - 0.6.1 alpha 16 [YANKED]
+
+## 0.6.1 alpha 13 - 2022-05-20
+
+### Added
+
+-   New script command to export and import scripts
+-   New email_templates command to manage email templates
+-   New application command to export and import oauth2 clients
+-   New realm command to manage realms
+-   New secret command to manage Identity Cloud secrets
+-   New theme command to manage hosted pages UI themes
+-   New admin command to perform advanced administrative tasks
+-   Encrypt the password value in the connection profile
+-   Added progress bars/spinners for long running operations
+-   Added version option -v, --version
+-   Auto provisioning of log API keys
+-   Added initial unit testing
+
+### Changed
+
+-   Improved performance of journey command (multi-threading)
+-   Consolidated settings under one folder (~/.frodo)
+-   Proposed new code formatting (prettier) and style (eslint) rules
+-   Updated readme
+-   Update to node 18
+
+### Fixed
+
+-   Fixed problem with adding connection profiles
+-   Miscellaneous bug fixes
+
+[Unreleased]: https://github.com/rockcarver/frodo/compare/v0.10.4...HEAD
+
+[0.10.4]: https://github.com/rockcarver/frodo/compare/v0.10.3...v0.10.4
+
+[0.10.3]: https://github.com/rockcarver/frodo/compare/v0.10.3-0...v0.10.3
+
+[0.10.3-0]: https://github.com/rockcarver/frodo/compare/v0.10.2...v0.10.3-0
+
+[0.10.2]: https://github.com/rockcarver/frodo/compare/v0.10.2-0...v0.10.2
+
+[0.10.2-0]: https://github.com/rockcarver/frodo/compare/v0.10.1...v0.10.2-0
+
+[0.10.1]: https://github.com/rockcarver/frodo/compare/v0.10.0...v0.10.1
+
+[0.10.0]: https://github.com/rockcarver/frodo/compare/v0.9.3-7...v0.10.0
+
+[0.9.3-7]: https://github.com/rockcarver/frodo/compare/v0.9.3-6...v0.9.3-7
+
+[0.9.3-6]: https://github.com/rockcarver/frodo/compare/v0.9.3-5...v0.9.3-6
+
+[0.9.3-5]: https://github.com/rockcarver/frodo/compare/v0.9.3-4...v0.9.3-5
+
+[0.9.3-4]: https://github.com/rockcarver/frodo/compare/v0.9.3-3...v0.9.3-4
+
+[0.9.3-3]: https://github.com/rockcarver/frodo/compare/v0.9.3-2...v0.9.3-3
+
+[0.9.3-2]: https://github.com/rockcarver/frodo/compare/v0.9.3-1...v0.9.3-2
+
+[0.9.3-1]: https://github.com/rockcarver/frodo/compare/v0.9.3-0...v0.9.3-1
+
+[0.9.3-0]: https://github.com/rockcarver/frodo/compare/v0.9.2...v0.9.3-0
+
+[0.9.2]: https://github.com/rockcarver/frodo/compare/v0.9.2-12...v0.9.2
+
+[0.9.2-12]: https://github.com/rockcarver/frodo/compare/v0.9.2-11...v0.9.2-12
+
+[0.9.2-11]: https://github.com/rockcarver/frodo/compare/v0.9.2-10...v0.9.2-11
+
+[0.9.2-10]: https://github.com/rockcarver/frodo/compare/v0.9.2-9...v0.9.2-10
+
+[0.9.2-9]: https://github.com/rockcarver/frodo/compare/v0.9.2-8...v0.9.2-9
+
+[0.9.2-8]: https://github.com/rockcarver/frodo/compare/v0.9.2-7...v0.9.2-8
+
+[0.9.2-7]: https://github.com/rockcarver/frodo/compare/v0.9.2-6...v0.9.2-7
+
+[0.9.2-6]: https://github.com/rockcarver/frodo/compare/v0.9.2-5...v0.9.2-6
+
+[0.9.2-5]: https://github.com/rockcarver/frodo/compare/v0.9.2-4...v0.9.2-5
+
+[0.9.2-4]: https://github.com/rockcarver/frodo/compare/v0.9.2-3...v0.9.2-4
+
+[0.9.2-3]: https://github.com/rockcarver/frodo/compare/v0.9.2-2...v0.9.2-3
+
+[0.9.2-2]: https://github.com/rockcarver/frodo/compare/v0.9.2-1...v0.9.2-2
+
+[0.9.2-1]: https://github.com/rockcarver/frodo/compare/v0.9.2-0...v0.9.2-1
+
+[0.9.2-0]: https://github.com/rockcarver/frodo/compare/v0.9.1...v0.9.2-0
+
+[0.9.1]: https://github.com/rockcarver/frodo/compare/v0.9.1-1...v0.9.1
+
+[0.9.1-1]: https://github.com/rockcarver/frodo/compare/v0.9.1-0...v0.9.1-1
+
+[0.9.1-0]: https://github.com/rockcarver/frodo/compare/v0.9.0...v0.9.1-0
+
+[0.9.0]: https://github.com/rockcarver/frodo/compare/v0.8.2...v0.9.0
+
+[0.8.2]: https://github.com/rockcarver/frodo/compare/v0.8.2-1...v0.8.2
+
+[0.8.2-1]: https://github.com/rockcarver/frodo/compare/v0.8.2-0...v0.8.2-1
+
+[0.8.2-0]: https://github.com/rockcarver/frodo/compare/v0.8.1...v0.8.2-0
+
+[0.8.1]: https://github.com/rockcarver/frodo/compare/v0.8.1-0...v0.8.1
+
+[0.8.1-0]: https://github.com/rockcarver/frodo/compare/v0.8.0...v0.8.1-0
+
+[0.8.0]: https://github.com/rockcarver/frodo/compare/v0.7.1-1...v0.8.0
+
+[0.7.1-1]: https://github.com/rockcarver/frodo/compare/v0.7.1-0...v0.7.1-1
+
+[0.7.1-0]: https://github.com/rockcarver/frodo/compare/v0.7.0...v0.7.1-0
+
+[0.7.0]: https://github.com/rockcarver/frodo/compare/v0.6.4-4...v0.7.0
+
+[0.6.4-4]: https://github.com/rockcarver/frodo/compare/v0.6.4-3...v0.6.4-4
+
+[0.6.4-3]: https://github.com/rockcarver/frodo/compare/v0.6.4-2...v0.6.4-3
+
+[0.6.4-2]: https://github.com/rockcarver/frodo/compare/v0.6.4-1...v0.6.4-2
+
+[0.6.4-1]: https://github.com/rockcarver/frodo/compare/v0.6.4-0...v0.6.4-1
+
+[0.6.4-0]: https://github.com/rockcarver/frodo/compare/v0.6.3...v0.6.4-0
+
+[0.6.3]: https://github.com/rockcarver/frodo/compare/v0.6.3-alpha.51...v0.6.3
+
+[0.6.3-alpha.51]: https://github.com/rockcarver/frodo/compare/6137b8b19f1c22af40af5afbf7a2e6c5a95b61cb...v0.6.3-alpha.51

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+schaturvedi@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Rock Carver
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,8 @@
+<!-- README.md for NPM; the one for GitHub is .github/README.md. -->
+# Frodo Library - @rockcarver/frodo-lib
+
+ForgeROck DO Library, frodo-lib, a library to manage ForgeRock platform deployments supporting Identity Cloud tenants, ForgeOps deployments, and classic deployments.
+
+Frodo-lib powers [frodo-cli](https://github.com/rockcarver/frodo-cli), the command line tool to manage ForgeRock deployments.
+
+Please refer to the [GitHub README](https://github.com/rockcarver/frodo-lib#readme) for full documentation.