tf-encrypted icon indicating copy to clipboard operation
tf-encrypted copied to clipboard
verified publisher icon tf-encrypted

README Improvements

Open gavinuhma opened this issue 6 years ago • 0 comments

Let's discuss some ways to improve the README.

If you're new to TFE

  1. Did the README do a good job of explaining TFE?
  2. Is it clear what TFE can be used for?
  3. How could the README be improved?

If you've been using TFE for a while

  1. Does the README represent how you think about TFE?
  2. Are the capabilities of the project accurately described?
  3. How could the README be improved?

Potential ideas to improve the README include (but are not limited to) improving...

  • Links
  • Descriptions
  • Getting started guide
  • How to contribute
  • General layout
  • Colours / fonts
  • Images / graphs
  • Explanations of cryptography concepts
  • Use cases
  • Examples
  • Tutorials
  • Privacy / security considerations
  • How TFE works / How it integrates with TensorFlow
  • Integrations with CI/project status tools.

Epic

  • [x] #607 - Add new colours / logo from tf-encrypted.io
  • [x] #575 - Conda installation instructions

^ We can create issues from any ideas

gavinuhma avatar Jul 12 '19 13:07 gavinuhma