-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from Anastasia-Labs/monorepo
docs: remove app/web, improve docs structure
- Loading branch information
Showing
25 changed files
with
63 additions
and
745 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Acknowledgements | ||
|
||
Lucid owes its origins to Spacebudz [alessandrokonrad](https://github.com/alessandrokonrad), who initially developed it as an open-source offering. | ||
In late 2023, when maintenance ceased, Anastasia Labs and others stepped up to the challenge of preserving and enhancing the codebase. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"index": "Quickstart", | ||
"install": "Installing Lucid", | ||
"getting-started": "Getting Started", | ||
"contact": "Contact Us" | ||
} |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Instantiate Lucid | ||
|
||
Lucid can be used with or without a blockchain provider, which allows you to query data and submit transactions. It's recommended to select a provider and network when using Lucid. Lucid currently supports the Mainnet, Preprod, and Preview networks, with Mainnet being the default selection if no network is specified. Throughout the entire docs we are making use of the Preprod network. | ||
|
||
```typescript | ||
import { Blockfrost, Lucid } from "lucid-evolution"; | ||
|
||
const lucid = await Lucid.new( | ||
new Blockfrost("https://cardano-preprod.blockfrost.io/api/v0", "<projectId>"), | ||
"Preprod", | ||
); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,8 @@ | ||
# Welcome to Lucid Evolution | ||
|
||
Hello, world! | ||
import { Callout } from 'nextra/components' | ||
|
||
<Callout type="warning" emoji="⚠️"> | ||
Please note that the documentation is currently under construction and some sections may be incomplete or subject to changes. | ||
We are working hard to provide you with comprehensive and accurate information. | ||
</Callout> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
import { Callout } from 'nextra/components' | ||
import { Tabs } from 'nextra/components' | ||
|
||
# Install | ||
Lucid works with yarn, npm, and pnpm on the following operating systems: | ||
|
||
- macOS darwin 64-bit (Intel), ARM 64-bit (Apple Silicon) | ||
- Linux 64-bit, ARM 64-bit | ||
- Windows 64-bit, ARM 64-bit | ||
|
||
<Callout type="warning" emoji="⚠️"> | ||
Use with caution, this library is currently in beta testing phase. Your feedback is greatly appreciated. | ||
</Callout> | ||
|
||
|
||
<Tabs items={['pnpm', 'npm', 'yarn']}> | ||
<Tabs.Tab>**pnpm**: Fast, disk space efficient package manager. </Tabs.Tab> | ||
<Tabs.Tab>**npm** is a package manager for the JavaScript programming language.</Tabs.Tab> | ||
<Tabs.Tab>**Yarn** is a software packaging system.</Tabs.Tab> | ||
</Tabs> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# License | ||
|
||
`Lucid evolution library is released under the MIT license` | ||
|
||
The MIT License (MIT) | ||
Copyright © 2024 Anastasia Labs | ||
|
||
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. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Binary file not shown.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.