Improve on our elevator pitch (one sentence summary)

fornwall commented 4 years ago

We should replace "Meeshkan CLI" below with a good sentence.

Related: Should we focus more on the mocking part, and downplay the recording and schema parts?

$ meeshkan --help
Usage: meeshkan [OPTIONS] COMMAND [ARGS]...

  Meeshkan CLI.

carolstran commented 4 years ago

My favorite is officially the hybrid that you and @mikesol came up with earlier: Create smart API sandboxes with minimal effort.

carolstran commented 4 years ago

The only part about it I'm hesitant with is minimal effort. I agree with the sentiment, but there might be a better tone to express that... not sure what though... but we can always iterate later!

aby2s commented 4 years ago

I've checked helps for some common commands. Never paid attention to them previously. Most commonly It is a full tool name, which could differ from a command name, a version, and sometimes a license. Here're some examples:

(py36) nikolay@nikolay-dell:~/projects/meeshkan/meeshkan$ mc --help
Usage:
  mc [OPTION...] [+number] [this_dir] [other_panel_dir]
 +number - Set initial line number for the internal editor

GNU Midnight Commander 4.8.15

(py36) nikolay@nikolay-dell:~/projects/meeshkan/meeshkan$ apt-get --help
apt 1.2.29 (amd64)

rsync help has a long text description after a tool name:

(py36) nikolay@nikolay-dell:~/projects/meeshkan/meeshkan$ rsync --help
rsync  version 3.1.1  protocol version 31
Copyright (C) 1996-2014 by Andrew Tridgell, Wayne Davison, and others.
Web site: http://rsync.samba.org/
Capabilities:
    64-bit files, 64-bit inums, 64-bit timestamps, 64-bit long ints,
    socketpairs, hardlinks, symlinks, IPv6, batchfiles, inplace,
    append, ACLs, xattrs, iconv, symtimes, prealloc

rsync comes with ABSOLUTELY NO WARRANTY.  This is free software, and you
are welcome to redistribute it under certain conditions.  See the GNU
General Public Licence for details.

rsync is a file transfer program capable of efficient remote update
via a fast differencing algorithm.

Only Docker came out with something creative:

(py36) nikolay@nikolay-dell:~/projects/meeshkan/meeshkan$ docker --help

Usage:  docker [OPTIONS] COMMAND

A self-sufficient runtime for containers

So for us, it could be something like "Meeshkan mocking toolkit v. X.X.X". Probably, we want to add something about MIT License and "Full documentation can be found at https://meeshkan.readthedocs.io"

We still need a good pitch but it is mostly for docs and readmes.

fornwall commented 4 years ago

Removed the Meeshkan CLI" sentence from--help` in #143, but we should still harmonise on a good one sentence summary for other places (the summary at the top of the github repo, the initial sentence in the README, the listing in openapitools and similar).

meeshkan / hmt

Improve on our elevator pitch (one sentence summary) #121