Skip to content

Commit

Permalink
Merge pull request #850 from freenet/develop
Browse files Browse the repository at this point in the history
Minor fixes to docs
  • Loading branch information
iduartgomez authored Sep 26, 2023
2 parents 20b94ac + 9826b7d commit 215d9d2
Show file tree
Hide file tree
Showing 8 changed files with 44 additions and 39 deletions.
4 changes: 2 additions & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ updates:
- package-ecosystem: "cargo"
directory: "/"
schedule:
interval: "daily"
open-pull-requests-limit: 9999
interval: "weekly"
open-pull-requests-limit: 50

- package-ecosystem: "github-actions"
directory: "/"
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ jobs:
uses: actions/checkout@v4
with:
fetch-depth: 0
submodules: true
- name: Setup Rust
uses: ATiltedTree/setup-rust@v1
with:
Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<a href="https://matrix.to/#/#freenet-locutus:matrix.org">
<img src="https://img.shields.io/matrix/freenet-locutus:matrix.org?label=matrix&logo=matrix&style=flat-square" alt="matrix" />
</a>
<a href="https://docs.rs/locutus">
<a href="https://docs.rs/freenet">
<img src="https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square&label=api%20docs"
alt="docs.rs docs" />
</a>
Expand Down Expand Up @@ -42,14 +42,14 @@ building decentralized applications using our SDK and testing them locally.

Examples of what can be built on Freenet include:

* Decentralized email (with a gateway to legacy email via the @freenet.org
- Decentralized email (with a gateway to legacy email via the @freenet.org
domain)
* Decentralized microblogging (think Twitter or Facebook)
* Instant Messaging (Whatsapp, Signal)
* Online Store (Amazon)
* Discussion (Reddit, HN)
* Video discovery (Youtube, TikTok)
* Search (Google, Bing)
- Decentralized microblogging (think Twitter or Facebook)
- Instant Messaging (Whatsapp, Signal)
- Online Store (Amazon)
- Discussion (Reddit, HN)
- Video discovery (Youtube, TikTok)
- Search (Google, Bing)

All will be completely decentralized, scalable, and cryptographically secure. We
want Freenet to be useful out-of-the-box, so we plan to provide reference
Expand All @@ -61,7 +61,7 @@ Freenet is a decentralized key-value database. It uses the same [small
world](https://freenetproject.org/assets/papers/lic.pdf) routing algorithm as
the original Freenet design, but each key is a cryptographic contract
implemented in [Web Assembly](https://webassembly.org/), and the value
associated with each contract is called its *state*. The role of the
associated with each contract is called its _state_. The role of the
cryptographic contract is to specify what state is allowed for this contract,
and how the state is modified.

Expand Down Expand Up @@ -116,14 +116,14 @@ development.
### Supporting Freenet

If you are in a position to fund our continued efforts please contact us on
[twitter](https://twitter.com/FreenetOrg) or by email at *ian at freenet dot
org*.
[twitter](https://twitter.com/FreenetOrg) or by email at _ian at freenet dot
org_.

## License

This project is licensed under either of:

* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
<http://www.apache.org/licenses/LICENSE-2.0>)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
- MIT license ([LICENSE-MIT](LICENSE-MIT) or
<http://opensource.org/licenses/MIT>)
36 changes: 20 additions & 16 deletions apps/freenet-microblogging/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion apps/freenet-microblogging/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ panic = 'abort'
strip = true

[workspace.dependencies]
freenet-stdlib = { path = "../../stdlib/rust", default-features = false }
freenet-stdlib = { version = "0.0.5", default-features = false }

#[target.wasm32-unknown-unknown]
#rustflags = ["-C", "link-arg=--import-memory"]
4 changes: 2 additions & 2 deletions apps/freenet-microblogging/web/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import {
GetResponse,
HostError,
ContractKey,
LocutusWsApi,
FreenetWsApi,
PutResponse,
UpdateNotification,
UpdateResponse,
Expand Down Expand Up @@ -146,7 +146,7 @@ const handler = {
};

const API_URL = new URL(`ws://${location.host}/contract/command`);
const locutusApi = new LocutusWsApi(API_URL, handler);
const locutusApi = new FreenetWsApi(API_URL, handler);

async function loadState() {
const key = ContractKey.fromInstanceId(MODEL_CONTRACT);
Expand Down
8 changes: 4 additions & 4 deletions docs/src/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ applications and interfacing with your local node, so we will make our
```json
{
"dependencies": {
"@freenet/freenet-stdlib": "0.0.2"
"@freenetorg/freenet-stdlib": "0.0.6"
}
}
```
Expand All @@ -196,11 +196,11 @@ import {
GetResponse,
HostError,
Key,
LocutusWsApi,
FreenetWsApi,
PutResponse,
UpdateNotification,
UpdateResponse,
} from "@locutus/locutus-stdlib/webSocketInterface";
} from "@freenetorg/freenet-stdlib/websocket-interface";

const handler = {
onPut: (_response: PutResponse) => {},
Expand All @@ -212,7 +212,7 @@ const handler = {
};

const API_URL = new URL(`ws://${location.host}/contract/command/`);
const locutusApi = new LocutusWsApi(API_URL, handler);
const locutusApi = new FreenetWsApi(API_URL, handler);

const CONTRACT = "DCBi7HNZC3QUZRiZLFZDiEduv5KHgZfgBk8WwTiheGq1";

Expand Down

0 comments on commit 215d9d2

Please sign in to comment.