GithubHelp home page GithubHelp logo

Comments (3)

Mubelotix avatar Mubelotix commented on May 18, 2024

The readme is not up to date. The readme should be written in the documentation code in src/lib.rs and then generated by cargo readme (must be installed). But the generated file (README.md) has been updated manually and the source has not been changed so we have to update the source (lib.rs) to include the changes made manually in the README.md file.

There is also some out to date information in the doc like the version of the crate which is still 0.1. Please update pieces of information directly in src/lib.rs and then run cargo readme to avoid differences between these two files.

from meilisearch-rust.

curquiza avatar curquiza commented on May 18, 2024

Ok, this issue is only about the manual README, the front page, to be consistent with the other SDKs READMEs. I'm going to open another issue for the generated one since it needs installation and configuration compared to a "classical" README.

Yes, the version is not up-to-date on the current README, but no rush, we are still a WIP 😉 I will change that asap.

from meilisearch-rust.

curquiza avatar curquiza commented on May 18, 2024

This PR #31 solves this issue and gives an example about what we want as a template to solve this issue #27!

from meilisearch-rust.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.