[steemconnect-firebase-functions] New documentation

in utopian-io •  last year

The library I created - steemconnect-firebase-functions - had one big issue that could have prevented one from using it in a project - lack of good documentation both in the code and in the README. I believe this is not a problem anymore.

Version 1.1.1

Btw... what is this project about?

If you haven't heard of steemconnect-firebase-functions before, this is a library designed to help developers who want to use SteemConnect on the Firebase platform.

Even though it was designed for Firebase, you can use most of its functionality in any NodeJS platform. What kind of functionality?

  • implementing OAuth2 Authorization Code Grant (enables user to log in to your app using SteemConnect)
  • broadcasting operations to Steem blockchain (post, comment, upvote, etc.)

Details

The old documentation in the README has been completely replaced with new, way more detailed one.

REAMDE docs example

Each function now has a description, a list of parameters along with their description and their type, and what is returns. Not only in the README, but also in the code in JSDocs format, for example:

/**
 * Broadcasts a post to the Steem blockchain and returns the result of the operation.
 * @param {string} accessToken The access_token of the user.
 * @param {string} mainTag The main tag of the post (not possible to change it later).
 * @param {string} postAuthor The username of the user who wants to add a post.
 * @param {string} postPermlink The permlink of the post.
 * @param {string} postTitle The title of the post.
 * @param {string} postBody The content of the post.
 * @param {Object} [jsonMetadata] Optional additional metadata (ex. the name of the app or additional tags).
 * @returns {Promise} Promise object that resolves into the result of the operation.
 */

results in:

VS Code

I believe it will be useful for all developers who want to use this library either on the Firebase or in any NodeJS environment. I divided the documentation into two main sections - any NodeJS environment functions and Firebase specific functions.

Components

As I said before, I had documented each function, so the entire project. Right now if you decide to use steemconnect-firebase-functions you will have easy access to docs - both while writing your code and in the README.

Links



Posted on Utopian.io - Rewarding Open Source Contributors

Authors get paid when people like you upvote their post.
If you enjoyed what you read here, create your account today and start earning FREE STEEM!
Sort Order:  

Thank you for the contribution. It has been approved.

You can contact us on Discord.

[utopian-moderator]

your post is very good and I like it, I'm very glad when you stop in my post, if you do not want anything too because I'm quite happy if we become a better friend thanks

this is very helpful about the knowledge of steemconnect-firebase-functions

Hey @jakipatryk I am @utopian-io. I have just upvoted you!

Achievements

  • You have less than 500 followers. Just gave you a gift to help you succeed!
  • Seems like you contribute quite often. AMAZING!

Community-Driven Witness!

I am the first and only Steem Community-Driven Witness. Participate on Discord. Lets GROW TOGETHER!

mooncryption-utopian-witness-gif

Up-vote this comment to grow my power and help Open Source contributions like this one. Want to chat? Join me on Discord https://discord.gg/Pc8HG9x

This post has been just added as new item to timeline of steemconnect-firebase-functions on Steem Projects.

If you want to be notified about new updates from this project, register on Steem Projects and add steemconnect-firebase-functions to your favorite projects.

this post very amazing , I really like it .thanks for shar