Code Monkey home page Code Monkey logo

Comments (2)

marcorosa avatar marcorosa commented on May 20, 2024

I agree.
I added a sample link and update the README with the instructions on how to use the models in the container.

from credential-digger.

copernico avatar copernico commented on May 20, 2024

Hi @marcorosa, I would advise to put all that is needed right in the section https://github.com/SAP/credential-digger#install

I would expect that when I run the steps in that section I end up with a fully functional instance (which is not the case, because I get no rules).

Overall, I would suggest to provide a very simple path from zero to a fully working instance of the tool in one clear set of steps. Optional or alternative ways should be identified as such and documented separately. Right now the readme provides too much information and alternatives, but not the single one-stop-shop for the curious newcomer and prospective adopter.

EDIT: also the section https://github.com/SAP/credential-digger#architecture should be moved down in the readm, or to a separate file altogether (better): that breaks the flow from the high-level description of what the tool does to how to actually try it; the question about how it is architected come later and only for a limited class of users.

from credential-digger.

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.