Skip to content

Commit 6310103

Browse files
committed
update readme
1 parent 8250fe4 commit 6310103

File tree

2 files changed

+11
-15
lines changed

2 files changed

+11
-15
lines changed

packages/api/README.md

+10-15
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,16 @@
1-
# Subsocial API by [DappForce](https://github.com/dappforce)
1+
Subsocial's JS SDK is a library for building social networking applications on top of the Subsocial blockchain. The library will help developers easily interact with the Subsocial blockchain from their UI, without any prior knowledge of Subsocial’s pallet implementations. Inside the library, you will find the APIs required to perform different operations on the blockchain, which are <a href="https://docs.subsocial.network/docs/develop/how-to-guides/apiTypes" target="_blank">detailed here</a>.
22

3-
JavaScript API wrappers for Substrate and IPFS specific to Subsocial blockchain.
3+
## What is Subsocial?
44

5-
## Install
5+
Subsocial provides the back-end tech, allowing for easy deployment of decentralized social dapps that share a social graph and content base. Users own their content and social connections on Subsocial, which automatically solves most of the problems of web2 social networks. Applications built on Subsocial do not have to be specifically focused on social networking, as Subsocial can support dapps like YouTube, Shopify, or even Airbnb. You can learn more about Subsocial by reading the <a href="https://docs.subsocial.network/docs/basics/" target="_blank">lightpaper</a>.
66

7-
Using npm:
7+
## Docs & Tools
88

9-
```bash
10-
npm i @subsocial/api
11-
```
9+
- <a href="https://docs.subsocial.network/docs/develop/developer-quickstart/" target="_blank">Subsocial Starter</a> – a React app template that helps you start building on Subsocial. It uses the SDK and hides away the boilerplate code and boring configuration.
10+
- <a href="https://docs.subsocial.network/docs/develop/sdk-cheatsheet/" target="_blank">SDK cheatsheet</a> – a short description of the most commonly used methods of the SDK.
11+
- <a href="https://js-sdk-api.subsocial.network/" target="_blank">TypeDoc API</a> – detailed documentation of the SDK where you can learn about all its methods, parameters, and interfaces; API references (Subsocial and Substrate API); JS objects; and more.
12+
- <a href="https://play.subsocial.network/" target="_blank">Playground</a> – an easy-to-use web app to experiment with Subsocial’s SDK. You can run different code samples and see the execution results.
1213

13-
Using yarn:
14+
## Need Help?
1415

15-
```bash
16-
yarn add @subsocial/api
17-
```
18-
19-
## License
20-
21-
Subsocial is [GPL 3.0](./LICENSE) licensed.
16+
In case you need help, the best way to reach us is through our [Subsocial Devs](https://t.me/+oUpF3nTHlCkwNzA6) Telegram chat or [#developers channel](https://discord.gg/avccqJAW3C) on our Discord server.

themes/main.css

+1
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,5 @@ div.col-4.col-menu.menu-sticky-wrap.menu-highlight {
2121
div.tsd-page-title > h2 {
2222
/* aligns horizontally title h2 with left menubar */
2323
margin: -0.2rem 0;
24+
font-size: 1.875rem;
2425
}

0 commit comments

Comments
 (0)